Skip to main content

ClosureHandler

Struct ClosureHandler 

Source
#[non_exhaustive]
pub struct ClosureHandler<B: Send + Sync + 'static, C: Clone + Send + 'static> { /* private fields */ }
Expand description

A JmapHandler that wraps an async closure over a shared backend and forwards CallerCtx to it.

Use this when your handler closures need per-request context — for example, an auth identity that controls which data the handler can access. The closure receives the whole CallContext and reads the fields it needs.

§Usage

ⓘ
use jmap_server::{ClosureHandler, Dispatcher};
use std::sync::Arc;

#[derive(Clone)]
struct AuthCtx { user_id: String }

let handler: Arc<ClosureHandler<MyBackend, AuthCtx>> =
    Arc::new(ClosureHandler::new(
        Arc::new(my_backend),
        |b, cx| {
            Box::pin(async move {
                // cx.caller.user_id is available here
                handle_something(&*b, cx.args, &cx.caller.user_id).await
            })
        },
    ));

let mut dispatcher: Dispatcher<AuthCtx> = Dispatcher::new();
dispatcher.register("MyMethod/get", handler);

A JmapHandler handle wrapping a shared backend + an async closure. Construct via ClosureHandler::new — the fields are crate-private (bd:JMAP-jfia.5) to keep the handle opaque, prevent post-construction hot-swap of the closure or backend, and let the constructor remain the sole site that enforces invariants when future fields (per-handler tracing context, metrics handle, etc.) are added.

Implementations§

Source§

impl<B: Send + Sync + 'static, C: Clone + Send + 'static> ClosureHandler<B, C>

Source

pub fn new<F>(backend: Arc<B>, call_fn: F) -> Self
where F: Fn(Arc<B>, CallContext<C>) -> HandlerFuture + Send + Sync + 'static,

Construct a ClosureHandler wrapping a shared backend and an async closure (bd:JMAP-wlip.17).

This is the supported construction path. The struct is #[non_exhaustive] so future fields (per-handler tracing context, metrics handle, timeout, etc.) can be added without a major-version bump — external callers MUST go through new rather than struct-literal syntax.

The call_fn parameter is generic over F: Fn(Arc<B>, CallContext<C>) + Send + Sync + 'static (bd:JMAP-jfia.40), so callers can pass a closure directly without wrapping it in Box::new; an already-boxed closure also satisfies the bound. Internally, the closure is boxed once at construction and stored as Box<BackendCallFn<B, C>>.

Trait Implementations§

Source§

impl<B: Send + Sync + 'static, C: Clone + Send + 'static> JmapHandler<C> for ClosureHandler<B, C>

Source§

fn call(&self, cx: CallContext<C>) -> HandlerFuture

Handle one method call. See CallContext for what cx carries.

Auto Trait Implementations§

§

impl<B, C> !RefUnwindSafe for ClosureHandler<B, C>

§

impl<B, C> !UnwindSafe for ClosureHandler<B, C>

§

impl<B, C> Forget for ClosureHandler<B, C>

§

impl<B, C> Freeze for ClosureHandler<B, C>
where Arc<B>: Freeze, Box<dyn Fn(Arc<B>, CallContext<C>) -> Pin<Box<dyn Future<Output = Result<HandlerOutput, JmapError>> + Send>> + Send + Sync>: Freeze,

§

impl<B, C> Move for ClosureHandler<B, C>

§

impl<B, C> Send for ClosureHandler<B, C>
where Arc<B>: Send, Box<dyn Fn(Arc<B>, CallContext<C>) -> Pin<Box<dyn Future<Output = Result<HandlerOutput, JmapError>> + Send>> + Send + Sync>: Send,

§

impl<B, C> Sync for ClosureHandler<B, C>
where Arc<B>: Sync, Box<dyn Fn(Arc<B>, CallContext<C>) -> Pin<Box<dyn Future<Output = Result<HandlerOutput, JmapError>> + Send>> + Send + Sync>: Sync,

§

impl<B, C> Unpin for ClosureHandler<B, C>
where Arc<B>: Unpin, Box<dyn Fn(Arc<B>, CallContext<C>) -> Pin<Box<dyn Future<Output = Result<HandlerOutput, JmapError>> + Send>> + Send + Sync>: Unpin,

§

impl<B, C> UnsafeUnpin for ClosureHandler<B, C>
where Arc<B>: UnsafeUnpin, Box<dyn Fn(Arc<B>, CallContext<C>) -> Pin<Box<dyn Future<Output = Result<HandlerOutput, JmapError>> + Send>> + Send + Sync>: UnsafeUnpin,

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> ErasedDestructor for T
where T: 'static,

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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<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