Struct roa::Context

source · [−]

pub struct Context<S = ()> {
    pub req: Request,
    pub resp: Response,
    pub exec: Executor,
    pub remote_addr: SocketAddr,
    /* private fields */
}

Expand description

A structure to share request, response and other data between middlewares.

Example

use roa_core::{App, Context, Next, Result};
use tracing::info;
use tokio::fs::File;

let app = App::new().gate(gate).end(end);
async fn gate(ctx: &mut Context, next: Next<'_>) -> Result {
    info!("{} {}", ctx.method(), ctx.uri());
    next.await
}

async fn end(ctx: &mut Context) -> Result {
    ctx.resp.write_reader(File::open("assets/welcome.html").await?);
    Ok(())
}

Fields

req: Request

The request, to read http method, uri, version, headers and body.

resp: Response

The response, to set http status, version, headers and body.

exec: Executor

The executor, to spawn futures or blocking works.

remote_addr: SocketAddr

Socket addr of last client or proxy.

Implementations

source

impl<S> Context<S>

source

pub fn uri(&self) -> &Uri

Clone URI.

Example

use roa_core::{App, Context, Result};

let app = App::new().end(get);

async fn get(ctx: &mut Context) -> Result {
    assert_eq!("/", ctx.uri().to_string());
    Ok(())
}

source

pub fn method(&self) -> &Method

Clone request::method.

Example

use roa_core::{App, Context, Result};
use roa_core::http::Method;

let app = App::new().end(get);

async fn get(ctx: &mut Context) -> Result {
    assert_eq!(Method::GET, ctx.method());
    Ok(())
}

source

pub fn get(&self, name: impl AsHeaderName) -> Option<&str>

Search for a header value and try to get its string reference.

Example

use roa_core::{App, Context, Result};
use roa_core::http::header::CONTENT_TYPE;

let app = App::new().end(get);

async fn get(ctx: &mut Context) -> Result {
    assert_eq!(
        Some("text/plain"),
        ctx.get(CONTENT_TYPE),
    );
    Ok(())
}

source

pub fn must_get(&self, name: impl AsHeaderName) -> Result<&str, Status>

Search for a header value and get its string reference.

Otherwise return a 400 BAD REQUEST.

Example

use roa_core::{App, Context, Result};
use roa_core::http::header::CONTENT_TYPE;

let app = App::new().end(get);

async fn get(ctx: &mut Context) -> Result {
    assert_eq!(
        "text/plain",
        ctx.must_get(CONTENT_TYPE)?,
    );
    Ok(())
}

source

pub fn status(&self) -> StatusCode

Clone response::status.

Example

use roa_core::{App, Context, Result};
use roa_core::http::StatusCode;

let app = App::new().end(get);

async fn get(ctx: &mut Context) -> Result {
    assert_eq!(StatusCode::OK, ctx.status());
    Ok(())
}

source

pub fn version(&self) -> Version

Clone request::version.

Example

use roa_core::{App, Context, Result};
use roa_core::http::Version;

let app = App::new().end(get);

async fn get(ctx: &mut Context) -> Result {
    assert_eq!(Version::HTTP_11, ctx.version());
    Ok(())
}

source

pub fn store_scoped<SC, K, V>(
 &mut self,
 scope: SC,
 key: K,
 value: V
) -> Option<Arc<V>> where
 SC: Any,
 K: Into<Cow<'static, str>>,
 V: Value,

Store key-value pair in specific scope.

Example

use roa_core::{App, Context, Result, Next};

struct Scope;
struct AnotherScope;

async fn gate(ctx: &mut Context, next: Next<'_>) -> Result {
    ctx.store_scoped(Scope, "id", "1".to_string());
    next.await
}

async fn end(ctx: &mut Context) -> Result {
    assert_eq!(1, ctx.load_scoped::<Scope, String>("id").unwrap().parse::<i32>()?);
    assert!(ctx.load_scoped::<AnotherScope, String>("id").is_none());
    Ok(())
}

let app = App::new().gate(gate).end(end);

source

pub fn store<K, V>(&mut self, key: K, value: V) -> Option<Arc<V>> where
K: Into<Cow<'static, str>>,
V: Value,

Store key-value pair in public scope.

Example

use roa_core::{App, Context, Result, Next};

async fn gate(ctx: &mut Context, next: Next<'_>) -> Result {
    ctx.store("id", "1".to_string());
    next.await
}

async fn end(ctx: &mut Context) -> Result {
    assert_eq!(1, ctx.load::<String>("id").unwrap().parse::<i32>()?);
    Ok(())
}

let app = App::new().gate(gate).end(end);

source

pub fn load_scoped<SC, V>(&self, key: &'a str) -> Option<Variable<'a, V>> where
SC: Any,
V: Value,

Search for value by key in specific scope.

Example

use roa_core::{App, Context, Result, Next};

struct Scope;

async fn gate(ctx: &mut Context, next: Next<'_>) -> Result {
    ctx.store_scoped(Scope, "id", "1".to_owned());
    next.await
}

async fn end(ctx: &mut Context) -> Result {
    assert_eq!(1, ctx.load_scoped::<Scope, String>("id").unwrap().parse::<i32>()?);
    Ok(())
}

let app = App::new().gate(gate).end(end);

source

pub fn load<V>(&self, key: &'a str) -> Option<Variable<'a, V>> where
V: Value,

Search for value by key in public scope.

Example

use roa_core::{App, Context, Result, Next};

async fn gate(ctx: &mut Context, next: Next<'_>) -> Result {
    ctx.store("id", "1".to_string());
    next.await
}

async fn end(ctx: &mut Context) -> Result {
    assert_eq!(1, ctx.load::<String>("id").unwrap().parse::<i32>()?);
    Ok(())
}

let app = App::new().gate(gate).end(end);

Trait Implementations

source

impl<S> Clone for Context<S> where
S: Clone,

source

pub fn clone(&self) -> Context<S>

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

impl<S> CookieGetter for Context<S>

This is supported on crate feature cookies only.

source

fn must_cookie(&mut self, name: &str) -> Result<Arc<Cookie<'static>>>

Must get a cookie, throw 401 UNAUTHORIZED if it not exists.

Try to get a cookie, return None if it not exists. Read more

source

impl<S> CookieSetter for Context<S>

This is supported on crate feature cookies only.

source

fn set_cookie(&mut self, cookie: Cookie<'_>) -> Result

Set a cookie in pecent encoding, should not return Err. Read more

source

impl<S> Deref for Context<S>

type Target = S

The resulting type after dereferencing.

source

pub fn deref(&self) -> &<Context<S> as Deref>::Target

Dereferences the value.

source

impl<S> DerefMut for Context<S>

source

pub fn deref_mut(&mut self) -> &mut <Context<S> as Deref>::Target

Mutably dereferences the value.

source

impl<S: State> Forward for Context<S>

source

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

Get true host. Read more

source

fn client_ip(&self) -> IpAddr

Get true client ip. Read more

source

fn forwarded_ips(&self) -> Vec<IpAddr>ⓘ
Notable traits for Vec<u8, A>
`impl<A> Write for Vec<u8, A> where A: Allocator,`

Get true forwarded ips. Read more

source

fn forwarded_proto(&self) -> Option<&str>

Try to get forwarded proto. Read more

source

impl<S> JwtVerifier<S> for Context<S>

This is supported on crate feature jwt only.

source

fn claims<C>(&self) -> Result<C> where
C: 'static + DeserializeOwned,

Deserialize claims from token.

source

fn verify<C>(&mut self, validation: &Validation) -> Result<C> where
C: 'static + DeserializeOwned,

Verify token and deserialize claims with a validation. Use this method if this validation is different from that one of JwtGuard. Read more

source

impl<S: State> PowerBody for Context<S>

source

fn read<'life0, 'async_trait>(
 &'life0 mut self
) -> Pin<Box<dyn Future<Output = Result<Vec<u8>>> + Send + 'async_trait>> where
 'life0: 'async_trait,
 Self: 'async_trait,

read request body as Bytes.

source

fn read_json<'life0, 'async_trait, B>(
 &'life0 mut self
) -> Pin<Box<dyn Future<Output = Result> + Send + 'async_trait>> where
 B: DeserializeOwned,
 B: 'async_trait,
 'life0: 'async_trait,
 Self: 'async_trait,

This is supported on crate feature json only.

read request body as “json”.

source

fn read_form<'life0, 'async_trait, B>(
 &'life0 mut self
) -> Pin<Box<dyn Future<Output = Result> + Send + 'async_trait>> where
 B: DeserializeOwned,
 B: 'async_trait,
 'life0: 'async_trait,
 Self: 'async_trait,

This is supported on crate feature urlencoded only.

read request body as “urlencoded form”.

source

fn read_multipart<'life0, 'async_trait>(
 &'life0 mut self
) -> Pin<Box<dyn Future<Output = Result<Multipart<'_>>> + Send + 'async_trait>> where
 'life0: 'async_trait,
 Self: 'async_trait,

This is supported on crate feature multipart only.

read request body as “multipart form”.

source

fn write_json(&mut self, data: &B) -> Result where
B: Serialize,

This is supported on crate feature json only.

write object to response body as “application/json”

source

fn render(&mut self, data: &B) -> Result where
B: Template,

This is supported on crate feature template only.

write object to response body as “text/html; charset=utf-8”

source

fn write(&mut self, data: B) where
B: Into<Bytes>,

write object to response body as “text/plain”

source

fn write_reader(&mut self, reader: B) where
B: 'static + AsyncRead + Unpin + Sync + Send,

write object to response body as “application/octet-stream”

source

fn write_file<'life0, 'async_trait, P>(
 &'life0 mut self,
 path: P,
 typ: DispositionType
) -> Pin<Box<dyn Future<Output = Result> + Send + 'async_trait>> where
 P: Send + AsRef<Path>,
 P: 'async_trait,
 'life0: 'async_trait,
 Self: 'async_trait,

This is supported on crate feature file only.

write object to response body as extension name of file

source

impl<S> Query for Context<S>

source

fn must_query<'a>(&self, name: &'a str) -> Result<Variable<'a, String>>

Must get a variable, throw 400 BAD_REQUEST if it not exists. Read more

source

fn query<'a>(&self, name: &'a str) -> Option<Variable<'a, String>>

Query a variable, return None if it not exists. Read more

source

impl<S> RouterParam for Context<S>

This is supported on crate feature router only.

source

fn must_param<'a>(&self, name: &'a str) -> Result<Variable<'a, String>>

Must get a router parameter, throw 500 INTERNAL SERVER ERROR if it not exists.

source

fn param<'a>(&self, name: &'a str) -> Option<Variable<'a, String>>

Try to get a router parameter, return None if it not exists. Read more

Auto Trait Implementations

impl<S = ()> !RefUnwindSafe for Context<S>

impl<S> Send for Context<S> where
S: Send,

impl<S> Sync for Context<S> where
S: Sync,

impl<S> Unpin for Context<S> where
S: Unpin,

impl<S = ()> !UnwindSafe for Context<S>

Blanket Implementations

source

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

source

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

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

source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

source

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

Mutably borrows from an owned value. Read more

impl<T> Conv for T

fn conv<T>(self) -> T where
Self: Into<T>,

Converts self into T using Into<T>. Read more

impl<T> Conv for T

fn conv<T>(self) -> T where
Self: Into<T>,

Converts self into a target type. Read more

impl<T> FmtForward for T

fn fmt_binary(self) -> FmtBinary<Self> where
Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.

fn fmt_display(self) -> FmtDisplay<Self> where
Self: Display,

Causes self to use its Display implementation when Debug-formatted. Read more

fn fmt_lower_exp(self) -> FmtLowerExp<Self> where
Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted. Read more

fn fmt_lower_hex(self) -> FmtLowerHex<Self> where
Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted. Read more

fn fmt_octal(self) -> FmtOctal<Self> where
Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.

fn fmt_pointer(self) -> FmtPointer<Self> where
Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted. Read more

fn fmt_upper_exp(self) -> FmtUpperExp<Self> where
Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted. Read more

fn fmt_upper_hex(self) -> FmtUpperHex<Self> where
Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted. Read more

source

impl<T> From<T> for T

source

pub fn from(t: T) -> T

Performs the conversion.

source

impl<T> Instrument for T

source

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

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

source

fn in_current_span(self) -> Instrumented<Self>

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

source

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

source

pub fn into(self) -> U

Performs the conversion.

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

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R

Pipes by value. This is generally the method you want to use. Read more

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R where
R: 'a,

Borrows self and passes that borrow into the pipe function. Read more

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R where
R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R where
 Self: Borrow,
 B: 'a + ?Sized,
 R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more

fn pipe_borrow_mut<'a, B, R>(
 &'a mut self,
 func: impl FnOnce(&'a mut B) -> R
) -> R where
 Self: BorrowMut,
 B: 'a + ?Sized,
 R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R where
 Self: AsRef,
 U: 'a + ?Sized,
 R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R where
 Self: AsMut,
 U: 'a + ?Sized,
 R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function. Read more

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R where
 Self: Deref<Target = T>,
 T: 'a + ?Sized,
 R: 'a,

Borrows self, then passes self.deref() into the pipe function.

fn pipe_deref_mut<'a, T, R>(
 &'a mut self,
 func: impl FnOnce(&'a mut T) -> R
) -> R where
 Self: DerefMut<Target = T> + Deref,
 T: 'a + ?Sized,
 R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function. Read more

impl<T> Pipe for T

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R

Pipes a value into a function that cannot ordinarily be called in suffix position. Read more

impl<T> PipeAsRef for T

fn pipe_as_ref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R where
 Self: AsRef<T>,
 T: 'a,
 R: 'a,

Pipes a trait borrow into a function that cannot normally be called in suffix position. Read more

fn pipe_as_mut<'a, T, R>(&'a mut self, func: impl FnOnce(&'a mut T) -> R) -> R where
 Self: AsMut<T>,
 T: 'a,
 R: 'a,

Pipes a trait mutable borrow into a function that cannot normally be called in suffix position. Read more

impl<T> PipeBorrow for T

fn pipe_borrow<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R where
 Self: Borrow<T>,
 T: 'a,
 R: 'a,

Pipes a trait borrow into a function that cannot normally be called in suffix position. Read more

fn pipe_borrow_mut<'a, T, R>(
 &'a mut self,
 func: impl FnOnce(&'a mut T) -> R
) -> R where
 Self: BorrowMut<T>,
 T: 'a,
 R: 'a,

Pipes a trait mutable borrow into a function that cannot normally be called in suffix position. Read more

impl<T> PipeDeref for T

fn pipe_deref<'a, R>(&'a self, func: impl FnOnce(&'a Self::Target) -> R) -> R where
Self: Deref,
R: 'a,

Pipes a dereference into a function that cannot normally be called in suffix position. Read more

fn pipe_deref_mut<'a, R>(
 &'a mut self,
 func: impl FnOnce(&'a mut Self::Target) -> R
) -> R where
 Self: DerefMut,
 R: 'a,

Pipes a mutable dereference into a function that cannot normally be called in suffix position. Read more

impl<T> PipeRef for T

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R where
R: 'a,

Pipes a reference into a function that cannot ordinarily be called in suffix position. Read more

fn pipe_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R where
R: 'a,

Pipes a mutable reference into a function that cannot ordinarily be called in suffix position. Read more

source

impl<T> Same<T> for T

type Output = T

Should always be Self

impl<T> Tap for T

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more

fn tap_borrow(self, func: impl FnOnce(&B)) -> Self where
Self: Borrow,
B: ?Sized,

Immutable access to the Borrow of a value. Read more

fn tap_borrow_mut(self, func: impl FnOnce(&mut B)) -> Self where
Self: BorrowMut,
B: ?Sized,

Mutable access to the BorrowMut of a value. Read more

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self where
Self: AsRef<R>,
R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self where
Self: AsMut<R>,
R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self where
Self: Deref<Target = T>,
T: ?Sized,

Immutable access to the Deref::Target of a value. Read more

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self where
Self: DerefMut<Target = T> + Deref,
T: ?Sized,

Mutable access to the Deref::Target of a value. Read more

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds. Read more

fn tap_borrow_dbg(self, func: impl FnOnce(&B)) -> Self where
Self: Borrow,
B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds. Read more

fn tap_borrow_mut_dbg(self, func: impl FnOnce(&mut B)) -> Self where
Self: BorrowMut,
B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds. Read more

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self where
Self: AsRef<R>,
R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds. Read more

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self where
Self: AsMut<R>,
R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds. Read more

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self where
Self: Deref<Target = T>,
T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds. Read more

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self where
Self: DerefMut<Target = T> + Deref,
T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds. Read more

impl<T> Tap for T

fn tap<F, R>(self, func: F) -> Self where
F: FnOnce(&Self) -> R,

Provides immutable access for inspection. Read more

fn tap_dbg<F, R>(self, func: F) -> Self where
F: FnOnce(&Self) -> R,

Calls tap in debug builds, and does nothing in release builds.

fn tap_mut<F, R>(self, func: F) -> Self where
F: FnOnce(&mut Self) -> R,

Provides mutable access for modification. Read more

fn tap_mut_dbg<F, R>(self, func: F) -> Self where
F: FnOnce(&mut Self) -> R,

Calls tap_mut in debug builds, and does nothing in release builds.

impl<T, U> TapAsRef for T where
U: ?Sized,

fn tap_ref<F, R>(self, func: F) -> Self where
Self: AsRef<T>,
F: FnOnce(&T) -> R,

Provides immutable access to the reference for inspection.

fn tap_ref_dbg<F, R>(self, func: F) -> Self where
Self: AsRef<T>,
F: FnOnce(&T) -> R,

Calls tap_ref in debug builds, and does nothing in release builds.

fn tap_ref_mut<F, R>(self, func: F) -> Self where
Self: AsMut<T>,
F: FnOnce(&mut T) -> R,

Provides mutable access to the reference for modification.

fn tap_ref_mut_dbg<F, R>(self, func: F) -> Self where
Self: AsMut<T>,
F: FnOnce(&mut T) -> R,

Calls tap_ref_mut in debug builds, and does nothing in release builds.

impl<T, U> TapBorrow for T where
U: ?Sized,

fn tap_borrow<F, R>(self, func: F) -> Self where
Self: Borrow<T>,
F: FnOnce(&T) -> R,

Provides immutable access to the borrow for inspection. Read more

fn tap_borrow_dbg<F, R>(self, func: F) -> Self where
Self: Borrow<T>,
F: FnOnce(&T) -> R,

Calls tap_borrow in debug builds, and does nothing in release builds.

fn tap_borrow_mut<F, R>(self, func: F) -> Self where
Self: BorrowMut<T>,
F: FnOnce(&mut T) -> R,

Provides mutable access to the borrow for modification.

fn tap_borrow_mut_dbg<F, R>(self, func: F) -> Self where
Self: BorrowMut<T>,
F: FnOnce(&mut T) -> R,

Calls tap_borrow_mut in debug builds, and does nothing in release builds. Read more

impl<T> TapDeref for T

fn tap_deref<F, R>(self, func: F) -> Self where
Self: Deref,
F: FnOnce(&Self::Target) -> R,

Immutably dereferences self for inspection.

fn tap_deref_dbg<F, R>(self, func: F) -> Self where
Self: Deref,
F: FnOnce(&Self::Target) -> R,

Calls tap_deref in debug builds, and does nothing in release builds.

fn tap_deref_mut<F, R>(self, func: F) -> Self where
Self: DerefMut,
F: FnOnce(&mut Self::Target) -> R,

Mutably dereferences self for modification.

fn tap_deref_mut_dbg<F, R>(self, func: F) -> Self where
Self: DerefMut,
F: FnOnce(&mut Self::Target) -> R,

Calls tap_deref_mut in debug builds, and does nothing in release builds. Read more

source

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

pub fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

pub fn clone_into(&self, target: &mut T)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T> TryConv for T

fn try_conv<T>(self) -> Result<T, Self::Error> where
Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more

impl<T> TryConv for T

fn try_conv<T>(self) -> Result<T, Self::Error> where
Self: TryInto<T>,

Attempts to convert self into a target type. Read more

source

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

type Error = Infallible

The type returned in the event of a conversion error.

source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

source

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

source

impl<T> WithSubscriber for T

source

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

source

fn with_current_subscriber(self) -> WithDispatch<Self>

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

source

Struct roa::Context

Fields

Implementations

impl<S> Context<S>

pub fn uri(&self) -> &Uri

pub fn method(&self) -> &Method

pub fn get(&self, name: impl AsHeaderName) -> Option<&str>

pub fn must_get(&self, name: impl AsHeaderName) -> Result<&str, Status>

pub fn status(&self) -> StatusCode

pub fn version(&self) -> Version

pub fn store_scoped<SC, K, V>( &mut self, scope: SC, key: K, value: V) -> Option<Arc<V>> where SC: Any, K: Into<Cow<'static, str>>, V: Value,

pub fn store<K, V>(&mut self, key: K, value: V) -> Option<Arc<V>> where K: Into<Cow<'static, str>>, V: Value,

pub fn load_scoped<SC, V>(&self, key: &'a str) -> Option<Variable<'a, V>> where SC: Any, V: Value,

pub fn load<V>(&self, key: &'a str) -> Option<Variable<'a, V>> where V: Value,

Trait Implementations

impl<S> Clone for Context<S> where S: Clone,

pub fn clone(&self) -> Context<S>

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

impl<S> CookieGetter for Context<S>

fn must_cookie(&mut self, name: &str) -> Result<Arc<Cookie<'static>>>

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

impl<S> CookieSetter for Context<S>

fn set_cookie(&mut self, cookie: Cookie<'_>) -> Result

impl<S> Deref for Context<S>

type Target = S

pub fn deref(&self) -> &<Context<S> as Deref>::Target

impl<S> DerefMut for Context<S>

pub fn deref_mut(&mut self) -> &mut <Context<S> as Deref>::Target

impl<S: State> Forward for Context<S>

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

fn client_ip(&self) -> IpAddr

fn forwarded_ips(&self) -> Vec<IpAddr>ⓘNotable traits for Vec<u8, A>impl<A> Write for Vec<u8, A> where A: Allocator,

fn forwarded_proto(&self) -> Option<&str>

impl<S> JwtVerifier<S> for Context<S>

fn claims<C>(&self) -> Result<C> where C: 'static + DeserializeOwned,

fn verify<C>(&mut self, validation: &Validation) -> Result<C> where C: 'static + DeserializeOwned,

impl<S: State> PowerBody for Context<S>

fn read<'life0, 'async_trait>( &'life0 mut self) -> Pin<Box<dyn Future<Output = Result<Vec<u8>>> + Send + 'async_trait>> where 'life0: 'async_trait, Self: 'async_trait,

fn read_json<'life0, 'async_trait, B>( &'life0 mut self) -> Pin<Box<dyn Future<Output = Result<B>> + Send + 'async_trait>> where B: DeserializeOwned, B: 'async_trait, 'life0: 'async_trait, Self: 'async_trait,

fn read_form<'life0, 'async_trait, B>( &'life0 mut self) -> Pin<Box<dyn Future<Output = Result<B>> + Send + 'async_trait>> where B: DeserializeOwned, B: 'async_trait, 'life0: 'async_trait, Self: 'async_trait,

fn read_multipart<'life0, 'async_trait>( &'life0 mut self) -> Pin<Box<dyn Future<Output = Result<Multipart<'_>>> + Send + 'async_trait>> where 'life0: 'async_trait, Self: 'async_trait,

fn write_json<B>(&mut self, data: &B) -> Result where B: Serialize,

fn render<B>(&mut self, data: &B) -> Result where B: Template,

fn write<B>(&mut self, data: B) where B: Into<Bytes>,

fn write_reader<B>(&mut self, reader: B) where B: 'static + AsyncRead + Unpin + Sync + Send,

fn write_file<'life0, 'async_trait, P>( &'life0 mut self, path: P, typ: DispositionType) -> Pin<Box<dyn Future<Output = Result> + Send + 'async_trait>> where P: Send + AsRef<Path>, P: 'async_trait, 'life0: 'async_trait, Self: 'async_trait,

impl<S> Query for Context<S>

fn must_query<'a>(&self, name: &'a str) -> Result<Variable<'a, String>>

fn query<'a>(&self, name: &'a str) -> Option<Variable<'a, String>>

impl<S> RouterParam for Context<S>

fn must_param<'a>(&self, name: &'a str) -> Result<Variable<'a, String>>

fn param<'a>(&self, name: &'a str) -> Option<Variable<'a, String>>

Auto Trait Implementations

impl<S = ()> !RefUnwindSafe for Context<S>

impl<S> Send for Context<S> where S: Send,

impl<S> Sync for Context<S> where S: Sync,

impl<S> Unpin for Context<S> where S: Unpin,

impl<S = ()> !UnwindSafe for Context<S>

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> Conv for T

fn conv<T>(self) -> T where Self: Into<T>,

impl<T> Conv for T

fn conv<T>(self) -> T where Self: Into<T>,

impl<T> FmtForward for T

fn fmt_binary(self) -> FmtBinary<Self> where Self: Binary,

fn fmt_display(self) -> FmtDisplay<Self> where Self: Display,

fn fmt_lower_exp(self) -> FmtLowerExp<Self> where Self: LowerExp,

fn fmt_lower_hex(self) -> FmtLowerHex<Self> where Self: LowerHex,

fn fmt_octal(self) -> FmtOctal<Self> where Self: Octal,

fn fmt_pointer(self) -> FmtPointer<Self> where Self: Pointer,

fn fmt_upper_exp(self) -> FmtUpperExp<Self> where Self: UpperExp,

fn fmt_upper_hex(self) -> FmtUpperHex<Self> where Self: UpperHex,

impl<T> From<T> for T

pub fn from(t: T) -> T

pub fn store_scoped<SC, K, V>(
&mut self,
scope: SC,
key: K,
value: V
) -> Option<Arc<V>> where
SC: Any,
K: Into<Cow<'static, str>>,
V: Value,

pub fn store<K, V>(&mut self, key: K, value: V) -> Option<Arc<V>> where
K: Into<Cow<'static, str>>,
V: Value,

pub fn load_scoped<SC, V>(&self, key: &'a str) -> Option<Variable<'a, V>> where
SC: Any,
V: Value,

pub fn load<V>(&self, key: &'a str) -> Option<Variable<'a, V>> where
V: Value,

impl<S> Clone for Context<S> where
S: Clone,

fn forwarded_ips(&self) -> Vec<IpAddr>ⓘ
Notable traits for Vec<u8, A>
`impl<A> Write for Vec<u8, A> where A: Allocator,`

fn claims<C>(&self) -> Result<C> where
C: 'static + DeserializeOwned,

fn verify<C>(&mut self, validation: &Validation) -> Result<C> where
C: 'static + DeserializeOwned,

fn read<'life0, 'async_trait>(
&'life0 mut self
) -> Pin<Box<dyn Future<Output = Result<Vec<u8>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,

fn read_json<'life0, 'async_trait, B>(
&'life0 mut self
) -> Pin<Box<dyn Future<Output = Result<B>> + Send + 'async_trait>> where
B: DeserializeOwned,
B: 'async_trait,
'life0: 'async_trait,
Self: 'async_trait,

fn read_form<'life0, 'async_trait, B>(
&'life0 mut self
) -> Pin<Box<dyn Future<Output = Result<B>> + Send + 'async_trait>> where
B: DeserializeOwned,
B: 'async_trait,
'life0: 'async_trait,
Self: 'async_trait,

fn read_multipart<'life0, 'async_trait>(
&'life0 mut self
) -> Pin<Box<dyn Future<Output = Result<Multipart<'_>>> + Send + 'async_trait>> where
'life0: 'async_trait,
Self: 'async_trait,

fn write_json<B>(&mut self, data: &B) -> Result where
B: Serialize,

fn render<B>(&mut self, data: &B) -> Result where
B: Template,

fn write<B>(&mut self, data: B) where
B: Into<Bytes>,

fn write_reader<B>(&mut self, reader: B) where
B: 'static + AsyncRead + Unpin + Sync + Send,

fn write_file<'life0, 'async_trait, P>(
&'life0 mut self,
path: P,
typ: DispositionType
) -> Pin<Box<dyn Future<Output = Result> + Send + 'async_trait>> where
P: Send + AsRef<Path>,
P: 'async_trait,
'life0: 'async_trait,
Self: 'async_trait,

impl<S> Send for Context<S> where
S: Send,

impl<S> Sync for Context<S> where
S: Sync,

impl<S> Unpin for Context<S> where
S: Unpin,

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,

fn conv<T>(self) -> T where
Self: Into<T>,

fn conv<T>(self) -> T where
Self: Into<T>,

fn fmt_binary(self) -> FmtBinary<Self> where
Self: Binary,

fn fmt_display(self) -> FmtDisplay<Self> where
Self: Display,

fn fmt_lower_exp(self) -> FmtLowerExp<Self> where
Self: LowerExp,

fn fmt_lower_hex(self) -> FmtLowerHex<Self> where
Self: LowerHex,

fn fmt_octal(self) -> FmtOctal<Self> where
Self: Octal,

fn fmt_pointer(self) -> FmtPointer<Self> where
Self: Pointer,

fn fmt_upper_exp(self) -> FmtUpperExp<Self> where
Self: UpperExp,

fn fmt_upper_hex(self) -> FmtUpperHex<Self> where
Self: UpperHex,

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

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

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R where
R: 'a,

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R where
R: 'a,

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R where
Self: Borrow<B>,
B: 'a + ?Sized,
R: 'a,

fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R
) -> R where
Self: BorrowMut<B>,
B: 'a + ?Sized,
R: 'a,

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R where
Self: AsRef<U>,
U: 'a + ?Sized,
R: 'a,

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R where
Self: AsMut<U>,
U: 'a + ?Sized,
R: 'a,

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R where
Self: Deref<Target = T>,
T: 'a + ?Sized,
R: 'a,

fn pipe_deref_mut<'a, T, R>(
&'a mut self,
func: impl FnOnce(&'a mut T) -> R
) -> R where
Self: DerefMut<Target = T> + Deref,
T: 'a + ?Sized,
R: 'a,

fn pipe_as_ref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R where
Self: AsRef<T>,
T: 'a,
R: 'a,

fn pipe_as_mut<'a, T, R>(&'a mut self, func: impl FnOnce(&'a mut T) -> R) -> R where
Self: AsMut<T>,
T: 'a,
R: 'a,

fn pipe_borrow<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R where
Self: Borrow<T>,
T: 'a,
R: 'a,

fn pipe_borrow_mut<'a, T, R>(
&'a mut self,
func: impl FnOnce(&'a mut T) -> R
) -> R where
Self: BorrowMut<T>,
T: 'a,
R: 'a,

fn pipe_deref<'a, R>(&'a self, func: impl FnOnce(&'a Self::Target) -> R) -> R where
Self: Deref,
R: 'a,

fn pipe_deref_mut<'a, R>(
&'a mut self,
func: impl FnOnce(&'a mut Self::Target) -> R
) -> R where
Self: DerefMut,
R: 'a,

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R where
R: 'a,

fn pipe_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R where
R: 'a,

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self where
Self: Borrow<B>,
B: ?Sized,

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self where
Self: BorrowMut<B>,
B: ?Sized,

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self where
Self: AsRef<R>,
R: ?Sized,

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self where
Self: AsMut<R>,
R: ?Sized,

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self where
Self: Deref<Target = T>,
T: ?Sized,

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self where
Self: DerefMut<Target = T> + Deref,
T: ?Sized,

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self where
Self: Borrow<B>,
B: ?Sized,

fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self where
Self: BorrowMut<B>,
B: ?Sized,

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self where
Self: AsRef<R>,
R: ?Sized,

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self where
Self: AsMut<R>,
R: ?Sized,

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self where
Self: Deref<Target = T>,
T: ?Sized,

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self where
Self: DerefMut<Target = T> + Deref,
T: ?Sized,

fn tap<F, R>(self, func: F) -> Self where
F: FnOnce(&Self) -> R,

fn tap_dbg<F, R>(self, func: F) -> Self where
F: FnOnce(&Self) -> R,

fn tap_mut<F, R>(self, func: F) -> Self where
F: FnOnce(&mut Self) -> R,