Skip to main content

StatefulEncryptedQueryBuilder

Struct StatefulEncryptedQueryBuilder 

Source
pub struct StatefulEncryptedQueryBuilder<T, S> { /* private fields */ }
Expand description

Route builder carrying shared state S and VEIL-encrypted query parameters of type T.

Obtained from EncryptedQueryBuilder::state or StatefulSocketBuilder::encrypted_query. On each matching request the ?data=<base64url> parameter is base64-decoded then VEIL-decrypted and a fresh clone of S is prepared before the handler is called. Any decode or decryption failure returns 403 Forbidden without ever invoking the handler.

Finalise with onconnect.

Implementations§

Source§

impl<T, S> StatefulEncryptedQueryBuilder<T, S>
where T: Decode<()> + Send + 'static, S: Clone + Send + Sync + 'static,

Source

pub fn onconnect<F, Fut, Re>(self, handler: F) -> SocketType
where F: Fn(S, T) -> Fut + Clone + Send + Sync + 'static, Fut: Future<Output = Result<Re, Rejection>> + Send, Re: Reply + Send,

Finalises this route with an async handler that receives (state: S, query: T).

On each request the ?data=<base64url> query parameter is base64-decoded then VEIL-decrypted using the configured SerializationKey and a fresh clone of S is prepared — both are handed to the handler together. If any step fails (missing parameter, bad encoding, wrong key, or corrupt data) the route returns 403 Forbidden and the handler is never invoked. The T the closure receives is always a trusted, fully-decrypted value ready to use.

The handler must return Result<impl Reply, Rejection>. Returns a SocketType ready to be passed to Server::mechanism.

Auto Trait Implementations§

§

impl<T, S> Freeze for StatefulEncryptedQueryBuilder<T, S>
where S: Freeze,

§

impl<T, S> RefUnwindSafe for StatefulEncryptedQueryBuilder<T, S>

§

impl<T, S> Send for StatefulEncryptedQueryBuilder<T, S>
where S: Send, T: Send,

§

impl<T, S> Sync for StatefulEncryptedQueryBuilder<T, S>
where S: Sync, T: Sync,

§

impl<T, S> Unpin for StatefulEncryptedQueryBuilder<T, S>
where S: Unpin, T: Unpin,

§

impl<T, S> UnsafeUnpin for StatefulEncryptedQueryBuilder<T, S>
where S: UnsafeUnpin,

§

impl<T, S> UnwindSafe for StatefulEncryptedQueryBuilder<T, S>
where S: UnwindSafe, T: UnwindSafe,

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

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

Source§

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