Struct Request 

pub struct Request<State: Clone + Send + Sync + 'static> { /* private fields */ }

Available on crate features clients or servers only.

A request that came from either a TCP/UDP source.

Implementations

impl<State> Request<State>

where State: Default + Clone + Send + Sync + 'static,

pub fn new( body: Bytes, source_address: SocketAddr, stream_id: Option<u64>, ) -> Self

impl<State: Clone + Send + Sync + 'static> Request<State>

pub fn new_with_state( body: Bytes, source_address: SocketAddr, state: State, stream_id: Option<u64>, ) -> Self

pub fn new_with_state_and_read_amount( body: Bytes, source_address: SocketAddr, state: State, stream_id: Option<u64>, explicit_read_amount: usize, ) -> Self

Available on crate feature clients only.

pub fn new_with_state_and_stream( body: Bytes, source_address: SocketAddr, state: State, stream_id: Option<u64>, stream_and_nagle_cache: Arc<Mutex<Option<(Option<BytesMut>, TcpStream)>>>, ) -> Self

Available on crate feature servers only.

pub fn swap_body(&mut self, new_body: Bytes)

Swap the body of the request to something new.

pub const fn update_request_source( &mut self, source: SocketAddr, stream_id: Option<u64>, )

Update the core request source.

pub fn stream_id(&self) -> u64

A unique identifier for the “stream” or connection of a packet.

In UDP which doesn’t have stream this uses the source address as the core identifier.

pub const fn explicit_read_amount(&self) -> Option<usize>

Available on crate feature clients only.

A client has requested we send this request, and then read an explicit amount of bytes, ignoring whatever the current NAGLE method is.

This is a utility only available when we are a client, and are receiving a packet that changes what our nagle split is for it’s specific response while keeping the nagle the same otherwise.

pub const fn set_explicit_read_amount(&mut self, new_read_amount: usize)

Available on crate feature clients only.

Override the current NAGLE algorithm being used by this client for this single request/response pair. Do a single non-nagle’d receive.

pub async fn unsafe_read_more_bytes_from_stream( &self, to_read: usize, ) -> Result<Bytes, CatBridgeError>

Available on crate feature servers only.

Attempt to read more bytes from the TCP Stream directly.

This is a utility only available when we are a server, and need to request more info from the client.

THIS WILL BYPASS EVERYYTHING PROVIDED BY TCP SERVER, AND JUST READ RAW BYTES FROM THE STREAM. This is only for requests like File I/O which need to bypass all the logic provided by the stream classes.

Errors

If the request has been moved outside of it’s original processing place, and it is no longer possible to read from the stream.

pub const fn body(&self) -> &Bytes

pub fn body_mut(&mut self) -> &mut Bytes

pub fn set_body(&mut self, new_body: Bytes)

pub fn body_owned(self) -> Bytes

pub const fn extensions(&self) -> &Extensions

pub fn extensions_mut(&mut self) -> &mut Extensions

pub fn extensions_owned(self) -> Extensions

pub const fn state(&self) -> &State

pub fn state_mut(&mut self) -> &mut State

pub const fn source(&self) -> &SocketAddr

pub fn is_ipv4(&self) -> bool

pub fn is_ipv6(&self) -> bool

Trait Implementations

impl<State: Clone + Send + Sync + 'static> Clone for Request<State>

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<State> Debug for Request<State>

where State: Debug + Clone + Send + Sync + 'static,

fn fmt(&self, fmt: &mut Formatter<'_>) -> FmtResult

Formats the value using the given formatter.

impl<Ty, State: Clone + Send + Sync + 'static> FromRef<Request<State>> for Option<Extension<Ty>>

where Ty: Clone + Send + Sync + 'static,

Available on crate feature servers only.

fn from_ref(input: &Request<State>) -> Self

Converts to this type from a reference to the input type.

impl<State: Clone + Send + Sync + 'static> FromRequest<State> for Request<State>

async fn from_request(req: Request<State>) -> Result<Self, CatBridgeError>

impl<ServiceTy, ExtensionTy, State> Service<Request<State>> for AddExtension<ServiceTy, ExtensionTy>

where ServiceTy: Service<Request<State>>, ExtensionTy: Clone + Send + Sync + 'static, State: Clone + Send + Sync + 'static,

Available on crate feature servers only.

type Response = <ServiceTy as Service<Request<State>>>::Response

Responses given by the service.

type Error = <ServiceTy as Service<Request<State>>>::Error

Errors produced by the service.

type Future = <ServiceTy as Service<Request<State>>>::Future

The future response value.

fn poll_ready(&mut self, ctx: &mut Context<'_>) -> Poll<Result<(), Self::Error>>

Returns Poll::Ready(Ok(())) when the service is able to process requests.

fn call(&mut self, req: Request<State>) -> Self::Future

Process the request and return the response asynchronously.

impl<HandlerTy, HandlerParamsTy, State: Clone + Send + Sync + 'static> Service<Request<State>> for HandlerAsService<HandlerTy, HandlerParamsTy>

where HandlerTy: Handler<HandlerParamsTy, State> + Clone + Send + 'static,

Available on crate feature servers only.

type Response = Response

Responses given by the service.

type Error = CatBridgeError

Errors produced by the service.

type Future = <HandlerTy as Handler<HandlerParamsTy, State>>::Future

The future response value.

fn poll_ready( &mut self, _ctx: &mut Context<'_>, ) -> Poll<Result<(), Self::Error>>

Returns Poll::Ready(Ok(())) when the service is able to process requests.

fn call(&mut self, req: Request<State>) -> Self::Future

Process the request and return the response asynchronously.

impl<Layered, State: Clone + Send + Sync + 'static> Service<Request<State>> for LayeredRequestID<Layered>

where Layered: Service<Request<State>, Response = Response, Error = Infallible> + Clone + Send + 'static, Layered::Future: Send + 'static,

type Response = <Layered as Service<Request<State>>>::Response

Responses given by the service.

type Error = <Layered as Service<Request<State>>>::Error

Errors produced by the service.

type Future = Instrumented<<Layered as Service<Request<State>>>::Future>

The future response value.

fn poll_ready(&mut self, ctx: &mut Context<'_>) -> Poll<Result<(), Self::Error>>

Returns Poll::Ready(Ok(())) when the service is able to process requests.

fn call(&mut self, req: Request<State>) -> Self::Future

Process the request and return the response asynchronously.

impl<Layered, State: Clone + Send + Sync + 'static> Service<Request<State>> for LayeredSataConnectionFlags<Layered>

where Layered: Service<Request<State>, Response = Response, Error = Infallible> + Clone + Send + 'static, Layered::Future: Send + 'static,

Available on crate feature servers only.

type Response = <Layered as Service<Request<State>>>::Response

Responses given by the service.

type Error = <Layered as Service<Request<State>>>::Error

Errors produced by the service.

type Future = <Layered as Service<Request<State>>>::Future

The future response value.

fn poll_ready(&mut self, ctx: &mut Context<'_>) -> Poll<Result<(), Self::Error>>

Returns Poll::Ready(Ok(())) when the service is able to process requests.

fn call(&mut self, req: Request<State>) -> Self::Future

Process the request and return the response asynchronously.

impl<Layered, State: Clone + Send + Sync + 'static> Service<Request<State>> for LayeredStreamID<Layered>

where Layered: Service<Request<State>, Response = Response, Error = Infallible> + Clone + Send + 'static, Layered::Future: Send + 'static,

type Response = <Layered as Service<Request<State>>>::Response

Responses given by the service.

type Error = <Layered as Service<Request<State>>>::Error

Errors produced by the service.

type Future = Instrumented<<Layered as Service<Request<State>>>::Future>

The future response value.

fn poll_ready(&mut self, ctx: &mut Context<'_>) -> Poll<Result<(), Self::Error>>

Returns Poll::Ready(Ok(())) when the service is able to process requests.

fn call(&mut self, req: Request<State>) -> Self::Future

Process the request and return the response asynchronously.

impl<Layered, State: Clone + Send + Sync + 'static> Service<Request<State>> for LayeredWALMessage<Layered>

where Layered: Service<Request<State>, Response = Response, Error = Infallible> + Clone + Send + 'static, Layered::Future: Send + 'static,

Available on crate feature servers only.

type Response = <Layered as Service<Request<State>>>::Response

Responses given by the service.

type Error = <Layered as Service<Request<State>>>::Error

Errors produced by the service.

type Future = Pin<Box<dyn Future<Output = Result<<LayeredWALMessage<Layered> as Service<Request<State>>>::Response, <LayeredWALMessage<Layered> as Service<Request<State>>>::Error>> + Send>>

The future response value.

fn poll_ready(&mut self, ctx: &mut Context<'_>) -> Poll<Result<(), Self::Error>>

Returns Poll::Ready(Ok(())) when the service is able to process requests.

fn call(&mut self, req: Request<State>) -> Self::Future

Process the request and return the response asynchronously.

impl<State: Clone + Send + Sync + 'static> Service<Request<State>> for Router<State>

Available on crate feature servers only.

type Response = Response

Responses given by the service.

type Error = Infallible

Errors produced by the service.

type Future = Pin<Box<dyn Future<Output = Result<<Router<State> as Service<Request<State>>>::Response, <Router<State> as Service<Request<State>>>::Error>> + Send>>

The future response value.

fn poll_ready( &mut self, _ctx: &mut Context<'_>, ) -> Poll<Result<(), Self::Error>>

Returns Poll::Ready(Ok(())) when the service is able to process requests.

fn call(&mut self, req: Request<State>) -> Self::Future

Process the request and return the response asynchronously.

impl<State: Clone + Send + Sync + 'static> Structable for Request<State>

fn definition(&self) -> StructDef<'_>

Returns the struct’s definition.

impl<State: Clone + Send + Sync + 'static> Valuable for Request<State>

fn as_value(&self) -> Value<'_>

Converts self into a Value instance.

fn visit(&self, visitor: &mut dyn Visit)

Calls the relevant method on Visit to extract data from self.

fn visit_slice(slice: &[Self], visit: &mut dyn Visit)

where Self: Sized,

Calls Visit::visit_primitive_slice() with self.