Struct viz::prelude::Context[−][src]

pub struct Context { /* fields omitted */ }

Expand description

The Context of an HTTP request - response.

Implementations

[src]

impl Context

[src]

pub fn new(req: Request<Body>) -> Context

Consumes the request to Context

[src]

pub fn method(&self) -> &Method

Returns a reference to the associated HTTP method.

[src]

pub fn version(&self) -> Version

Returns the associated version.

[src]

pub fn uri(&self) -> &Uri

Returns a reference to the associated URI.

[src]

pub fn path(&self) -> &str

Returns a reference to the associated path portion of the URL.

[src]

pub fn query_str(&self) -> &str

Returns a reference to the associated query portion of the URL.

[src]

pub fn host(&self) -> Option<&str>

Returns a reference to the associated host portion of the URL.

[src]

pub fn mime(&self) -> Option<Mime>

Gets content type

[src]

pub fn size(&self) -> Option<u64>

Gets content length

[src]

pub fn header_value(&self, key: impl AsRef<str>) -> Option<&HeaderValue>

Returns a reference to the associated header by key.

Returns a value by header key.

[src]

pub fn headers(&self) -> &HeaderMap<HeaderValue>

Returns a reference to the associated header field map.

[src]

pub fn extensions(&self) -> &Extensions

Returns a reference to the associated extensions.

[src]

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

Returns a mutable reference to the associated extensions.

[src]

pub fn take_body(&mut self) -> Option<Body>

Consumes the request, returning just the body.

[src]

pub fn middleware(
&self
) -> &Vec<Arc<dyn Handle<'a, Context, Output = Result<Response, Error>> + 'static>, Global>

Returns a reference to the associated middleware.

[src]

pub fn middleware_mut(
&mut self
) -> &mut Vec<Arc<dyn Handle<'a, Context, Output = Result<Response, Error>> + 'static>, Global>

Returns a mutable reference to the associated middleware.

[src]

pub async fn extract<T>(&'_ mut self) -> Result<T, <T as Extract>::Error> where
T: Extract,

Returns a data from the Context with a Extractor.

[src]

pub async fn next(&'_ mut self) -> Result<Response, Error>

Invokes the next middleware.

[src]

impl Context

Extends Context

[src]

pub fn config(&self) -> Arc<Config>

Gets application config

[src]

impl Context

[src]

pub fn cookies(&mut self) -> Result<Cookies, CookiesError>

Gets cookies.

Gets single cookie by name.

[src]

impl Context

[src]

pub async fn form<T>(&'_ mut self) -> Result<T, PayloadError> where
T: DeserializeOwned + Send + Sync,

Extracts Form Data from the request’ body.

[src]

impl Context

[src]

pub async fn json<T>(&'_ mut self) -> Result<T, PayloadError> where
T: DeserializeOwned,

Extracts JSON Data from the request’ body.

[src]

impl Context

[src]

pub fn multipart(&mut self) -> Result<FormData<Body>, PayloadError>

Extracts Multipart from the request’ body.

[src]

impl Context

[src]

pub fn params<T>(&self) -> Result<T, ParamsError> where
T: DeserializeOwned,

Gets parameters.

[src]

pub fn param<T>(&self, name: &str) -> Result<T, ParamsError> where
T: FromStr,
<T as FromStr>::Err: Display,

Gets single parameter by name.

[src]

impl Context

[src]

pub fn query<T>(&self) -> Result<T, PayloadError> where
T: DeserializeOwned,

Gets query parameters from the path

[src]

impl Context

[src]

pub fn state<T>(&self) -> Result<T, Error> where
T: 'static + Clone + Send + Sync,

Gets an app state.

Trait Implementations

[src]

impl Debug for Context

[src]

pub fn fmt(&self, fmt: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter. Read more

[src]

impl From<Request<Body>> for Context

[src]

pub fn from(req: Request<Body>) -> Context

Performs the conversion.

[src]

impl<'a, F, T> Handle<'a, Context> for HandlerWrapper<F, T> where
 T: 'static + Extract + Send + Sync,
 F: 'static + HandlerBase<T> + Send + Sync,
 <T as Extract>::Error: Into<Response>,
 <T as Extract>::Error: Send,

type Output = Result<Response, Error>

Returns Output

[src]

pub fn call(
&'a self,
cx: &'a mut Context
) -> Pin<Box<dyn Future<Output = <HandlerWrapper<F, T> as Handle<'a, Context>>::Output> + Send + 'a, Global>>

Invokes the handler within the given Context and then returns Output

[src]

impl<'a, F, T> Handle<'a, Context> for HandlerSuper<F, T> where
 T: 'static + Extract + Send + Sync,
 F: 'static + for<'h> HandlerCamp<'h, T> + Send + Sync,
 <T as Extract>::Error: Into<Response>,
 <T as Extract>::Error: Send,

type Output = Result<Response, Error>

Returns Output

[src]

pub fn call(
&'a self,
cx: &'a mut Context
) -> Pin<Box<dyn Future<Output = <HandlerSuper<F, T> as Handle<'a, Context>>::Output> + Send + 'a, Global>>

Invokes the handler within the given Context and then returns Output

[src]

impl<'a> Handle<'a, Context> for RouteHandler

type Output = Result<Response, Error>

Returns Output

[src]

pub fn call(
&'a self,
cx: &'a mut Context
) -> Pin<Box<dyn Future<Output = <RouteHandler as Handle<'a, Context>>::Output> + Send + 'a, Global>>

Invokes the handler within the given Context and then returns Output

Auto Trait Implementations

impl !RefUnwindSafe for Context

impl Send for Context

impl Sync for Context

impl Unpin for Context

impl !UnwindSafe for Context

Blanket Implementations

[src]

impl<T> Any for T where
T: 'static + ?Sized,

[src]

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

[src]

impl<T> Borrow<T> for T where
T: ?Sized,

[src]

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

[src]

impl<T> BorrowMut<T> for T where
T: ?Sized,

[src]

pub fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

[src]

impl<T> From<T> for T

[src]

pub fn from(t: T) -> T

Performs the conversion.

[src]

impl<T> Instrument for T

[src]

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

[src]

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

[src]

impl<T, U> Into for T where
U: From<T>,

[src]

pub fn into(self) -> U

Performs the conversion.

[src]

impl<T> Same<T> for T

type Output = T

Should always be Self

[src]

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

[src]

pub fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

[src]

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

[src]

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

pub fn vzip(self) -> V

[src]

impl<T> WithSubscriber for T

[src]

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

[src]

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

Struct viz::prelude::Context[−][src]

Implementations

impl Context

pub fn new(req: Request<Body>) -> Context

pub fn method(&self) -> &Method

pub fn version(&self) -> Version

pub fn uri(&self) -> &Uri

pub fn path(&self) -> &str

pub fn query_str(&self) -> &str

pub fn host(&self) -> Option<&str>

pub fn mime(&self) -> Option<Mime>

pub fn size(&self) -> Option<u64>

pub fn header_value(&self, key: impl AsRef<str>) -> Option<&HeaderValue>

pub fn header<T>(&self, key: impl AsRef<str>) -> Option<T> where T: FromStr,

pub fn headers(&self) -> &HeaderMap<HeaderValue>

pub fn extensions(&self) -> &Extensions

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

pub fn take_body(&mut self) -> Option<Body>

pub fn middleware( &self) -> &Vec<Arc<dyn Handle<'a, Context, Output = Result<Response, Error>> + 'static>, Global>

pub fn middleware_mut( &mut self) -> &mut Vec<Arc<dyn Handle<'a, Context, Output = Result<Response, Error>> + 'static>, Global>

pub async fn extract<T>(&'_ mut self) -> Result<T, <T as Extract>::Error> where T: Extract,

pub async fn next(&'_ mut self) -> Result<Response, Error>

impl Context

pub fn config(&self) -> Arc<Config>

impl Context

pub fn cookies(&mut self) -> Result<Cookies, CookiesError>

pub fn cookie(&self, name: &str) -> Option<Cookie<'_>>

impl Context

pub async fn form<T>(&'_ mut self) -> Result<T, PayloadError> where T: DeserializeOwned + Send + Sync,

impl Context

pub async fn json<T>(&'_ mut self) -> Result<T, PayloadError> where T: DeserializeOwned,

impl Context

pub fn multipart(&mut self) -> Result<FormData<Body>, PayloadError>

impl Context

pub fn params<T>(&self) -> Result<T, ParamsError> where T: DeserializeOwned,

pub fn param<T>(&self, name: &str) -> Result<T, ParamsError> where T: FromStr, <T as FromStr>::Err: Display,

impl Context

pub fn query<T>(&self) -> Result<T, PayloadError> where T: DeserializeOwned,

impl Context

pub fn state<T>(&self) -> Result<T, Error> where T: 'static + Clone + Send + Sync,

Trait Implementations

impl Debug for Context

pub fn fmt(&self, fmt: &mut Formatter<'_>) -> Result<(), Error>

impl From<Request<Body>> for Context

pub fn from(req: Request<Body>) -> Context

impl<'a, F, T> Handle<'a, Context> for HandlerWrapper<F, T> where T: 'static + Extract + Send + Sync, F: 'static + HandlerBase<T> + Send + Sync, <T as Extract>::Error: Into<Response>, <T as Extract>::Error: Send,

type Output = Result<Response, Error>

pub fn call( &'a self, cx: &'a mut Context) -> Pin<Box<dyn Future<Output = <HandlerWrapper<F, T> as Handle<'a, Context>>::Output> + Send + 'a, Global>>

impl<'a, F, T> Handle<'a, Context> for HandlerSuper<F, T> where T: 'static + Extract + Send + Sync, F: 'static + for<'h> HandlerCamp<'h, T> + Send + Sync, <T as Extract>::Error: Into<Response>, <T as Extract>::Error: Send,

type Output = Result<Response, Error>

pub fn call( &'a self, cx: &'a mut Context) -> Pin<Box<dyn Future<Output = <HandlerSuper<F, T> as Handle<'a, Context>>::Output> + Send + 'a, Global>>

impl<'a> Handle<'a, Context> for RouteHandler

type Output = Result<Response, Error>

pub fn call( &'a self, cx: &'a mut Context) -> Pin<Box<dyn Future<Output = <RouteHandler as Handle<'a, Context>>::Output> + Send + 'a, Global>>

Auto Trait Implementations

impl !RefUnwindSafe for Context

impl Send for Context

impl Sync for Context

impl Unpin for Context

impl !UnwindSafe for Context

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

pub fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

pub fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

pub fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

pub fn from(t: T) -> T

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

fn in_current_span(self) -> Instrumented<Self>

impl<T, U> Into<U> for T where U: From<T>,

pub fn into(self) -> U

impl<T> Same<T> for T

type Output = T

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

pub fn header<T>(&self, key: impl AsRef<str>) -> Option<T> where
T: FromStr,

pub fn middleware(
&self
) -> &Vec<Arc<dyn Handle<'a, Context, Output = Result<Response, Error>> + 'static>, Global>

pub fn middleware_mut(
&mut self
) -> &mut Vec<Arc<dyn Handle<'a, Context, Output = Result<Response, Error>> + 'static>, Global>

pub async fn extract<T>(&'_ mut self) -> Result<T, <T as Extract>::Error> where
T: Extract,

pub async fn form<T>(&'_ mut self) -> Result<T, PayloadError> where
T: DeserializeOwned + Send + Sync,

pub async fn json<T>(&'_ mut self) -> Result<T, PayloadError> where
T: DeserializeOwned,

pub fn params<T>(&self) -> Result<T, ParamsError> where
T: DeserializeOwned,

pub fn param<T>(&self, name: &str) -> Result<T, ParamsError> where
T: FromStr,
<T as FromStr>::Err: Display,

pub fn query<T>(&self) -> Result<T, PayloadError> where
T: DeserializeOwned,

pub fn state<T>(&self) -> Result<T, Error> where
T: 'static + Clone + Send + Sync,

impl<'a, F, T> Handle<'a, Context> for HandlerWrapper<F, T> where
T: 'static + Extract + Send + Sync,
F: 'static + HandlerBase<T> + Send + Sync,
<T as Extract>::Error: Into<Response>,
<T as Extract>::Error: Send,

pub fn call(
&'a self,
cx: &'a mut Context
) -> Pin<Box<dyn Future<Output = <HandlerWrapper<F, T> as Handle<'a, Context>>::Output> + Send + 'a, Global>>

impl<'a, F, T> Handle<'a, Context> for HandlerSuper<F, T> where
T: 'static + Extract + Send + Sync,
F: 'static + for<'h> HandlerCamp<'h, T> + Send + Sync,
<T as Extract>::Error: Into<Response>,
<T as Extract>::Error: Send,

pub fn call(
&'a self,
cx: &'a mut Context
) -> Pin<Box<dyn Future<Output = <HandlerSuper<F, T> as Handle<'a, Context>>::Output> + Send + 'a, Global>>

pub fn call(
&'a self,
cx: &'a mut Context
) -> Pin<Box<dyn Future<Output = <RouteHandler as Handle<'a, Context>>::Output> + Send + 'a, Global>>

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,