Skip to main content

StatefulJsonSocketBuilder

Struct StatefulJsonSocketBuilder 

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

Route builder that carries shared state S and expects a JSON body of type T.

Obtained from JsonSocketBuilder::state. S must be Clone + Send + Sync + 'static. T must implement serde::de::DeserializeOwned. Finalise with onconnect / onconnect_sync.

Implementations§

Source§

impl<T: DeserializeOwned + Send + 'static, S: Clone + Send + Sync + 'static> StatefulJsonSocketBuilder<T, S>

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, body: T).

On each request the incoming JSON body is deserialised into T and a fresh clone of S is prepared — both are handed to the handler together. The handler is only called when the body can be decoded; a missing or malformed body is rejected first.

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

Source

pub unsafe fn onconnect_sync<F, Re>(self, handler: F) -> SocketType
where F: Fn(S, T) -> Result<Re, Rejection> + Clone + Send + Sync + 'static, Re: Reply + Send + 'static,

Finalises this route with a synchronous handler that receives (state: S, body: T).

The body is decoded into T and a clone of S is prepared before the blocking handler is dispatched. If S wraps a lock, keep it held only briefly. See ServerMechanism::onconnect_sync for the full thread-pool safety notes.

Returns a SocketType ready to be passed to Server::mechanism.

§Safety

Every incoming request spawns an independent task on Tokio’s blocking thread pool. The pool caps the number of live OS threads (default 512), but the queue of waiting tasks is unbounded — under a traffic surge, tasks accumulate without limit, consuming unbounded memory and causing severe latency spikes or OOM crashes before any queued task gets a chance to run. When the handler acquires a lock on S (e.g. Arc<Mutex<_>>), concurrent blocking tasks contending on the same lock can stall indefinitely, causing the thread pool queue to grow without bound and compounding the exhaustion risk. Additionally, any panic inside the handler is silently converted into a Rejection, masking runtime errors. Callers must ensure the handler completes quickly, that lock contention on S cannot produce indefinite stalls, and that adequate backpressure or rate limiting is applied externally.

Auto Trait Implementations§

§

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

§

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

§

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

§

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

§

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

§

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

§

impl<T, S> UnwindSafe for StatefulJsonSocketBuilder<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