Struct quilkin::filters::ReadContext

#[non_exhaustive]
pub struct ReadContext {
    pub endpoints: UpstreamEndpoints,
    pub from: SocketAddr,
    pub contents: Vec<u8>,
    pub metadata: HashMap<Arc<String>, Box<dyn Any + Send>>,
}

The input arguments to Filter::read.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

endpoints: UpstreamEndpoints

The upstream endpoints that the packet will be forwarded to.

from: SocketAddr

The source of the received packet.

contents: Vec<u8>

Contents of the received packet.

metadata: HashMap<Arc<String>, Box<dyn Any + Send>>

Arbitrary values that can be passed from one filter to another.

Implementations

impl ReadContext

pub fn new(
    endpoints: UpstreamEndpoints,
    from: SocketAddr,
    contents: Vec<u8>
) -> Self

Creates a new ReadContext.

pub fn with_response(from: SocketAddr, response: ReadResponse) -> Self

Creates a new ReadContext from a given ReadResponse.

Trait Implementations

impl From<ReadContext> for ReadResponse

fn from(ctx: ReadContext) -> Self

Performs the conversion.