Struct CxBuilder 

pub struct CxBuilder { /* private fields */ }

Assembles the request context for an in-flight request.

The router creates a CxBuilder over the shared app context, then threads &mut CxBuilder through the layers wrapping the matched route so each can register request-scoped values with insert before the route runs. Because a CxBuilder dereferences to the Cx it is building, app and request context can be read through it (with app_context and request_context) while it is still being assembled.

Implementations

impl CxBuilder

pub fn new(app_context: Arc<ContextMap>) -> Self

Creates a builder over the shared app context, with an empty request context.

pub fn insert<T>(&mut self, value: T) -> Option<T>

where T: Any + Send + Sync,

Registers value on the request context, returning the value previously registered for T, if any.

A type can hold only one value at a time, so registering a type that is already present replaces it and hands back the displaced value.

pub fn contains<T>(&self) -> bool

where T: Any + Send + Sync,

Returns true if a value of type T has been registered on the request context.

pub fn get<T>(&self) -> Option<&T>

where T: Any + Send + Sync,

Returns a reference to the request context value of type T, or None if no such value has been registered.

pub fn get_mut<T>(&mut self) -> Option<&mut T>

where T: Any + Send + Sync,

Returns a mutable reference to the request context value of type T, or None if no such value has been registered.

pub fn build(self) -> Cx

Consumes the builder, returning the finished Cx.

Methods from Deref<Target = Cx>

pub fn id(&self) -> CxId

Returns this context’s unique CxId.

Trait Implementations

impl Debug for CxBuilder

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

Formats the value using the given formatter.

impl Default for CxBuilder

fn default() -> CxBuilder

Returns the “default value” for a type.

impl Deref for CxBuilder

type Target = Cx

The resulting type after dereferencing.

fn deref(&self) -> &Cx

Dereferences the value.