Skip to main content

Connection

Struct Connection 

Source
pub struct Connection<H, P = NoPush> { /* private fields */ }
Available on crate feature server only.
Expand description

One JMAP-over-WebSocket connection: a RequestHandler, a PushSource and limits. See the module docs.

Implementations§

Source§

impl<H: RequestHandler> Connection<H, NoPush>

Source

pub fn new(handler: Arc<H>) -> Self

A connection answering with handler, with no push (NoPush) and the default ConnectionConfig.

Source§

impl<H: RequestHandler, P: PushSource> Connection<H, P>

Source

pub fn with_push<Q: PushSource>(self, push: Q) -> Connection<H, Q>

Push notifications from push.

Source

pub fn with_config(self, config: ConnectionConfig) -> Self

Use config.

Source

pub fn with_shared_limit(self, limit: Arc<Semaphore>) -> Self

Also hold a permit of limit while each Request runs, failing the Request with maxConcurrentRequests when none is free. Share one semaphore with the HTTP API endpoint to apply the limit to “the sum of requests made on both” (RFC 8887 §4.3.2).

Source

pub fn with_extension<X: ExtensionHandler>(self, handler: X) -> Self

Route client messages of handler’s message_types to handler instead of answering them with notRequest. Call it once per extension capability the Session advertises; see ExtensionHandler for the order of calls.

§Panics

If one of the types is an RFC 8887 type (Request, WebSocketPushEnable, WebSocketPushDisable, Response, RequestError, StateChange) or was registered by an earlier handler: both are programming errors.

Source

pub fn close_handle(&self) -> CloseHandle

A handle that closes this connection while it runs, with a Close frame code and reason of the deployment’s choosing (for expired credentials, RFC 8887 §4.2). Take it before calling run; see CloseHandle for what closing does.

Source

pub async fn run<S, K, E>( self, incoming: S, outgoing: K, ) -> Result<(), ConnectionError>
where S: Stream<Item = Result<Inbound, E>> + Unpin, E: Error + Send + Sync + 'static, K: Sink<Outbound> + Unpin, K::Error: Error + Send + Sync + 'static,

Serve the connection until the client closes it, the incoming stream ends, or the deployment closes it.

Returns Ok after a Close, the end of incoming, a binary message under BinaryFrames::Close (after sending the Close), or a CloseHandle::close (after sending its Close). Requests still running then are dropped; method calls the Dispatcher already started still finish (see Dispatcher::dispatch, Cancellation). Before returning, by any path, it closes the extension message queue, waits for an ExtensionHandler::handle that is running, and calls every ExtensionHandler::close.

§Errors

ConnectionError if incoming or outgoing fails, or a message does not serialize.

Trait Implementations§

Source§

impl<H, P> Debug for Connection<H, P>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<H, P = NoPush> !RefUnwindSafe for Connection<H, P>

§

impl<H, P = NoPush> !Sync for Connection<H, P>

§

impl<H, P = NoPush> !UnwindSafe for Connection<H, P>

§

impl<H, P> Forget for Connection<H, P>

§

impl<H, P> Freeze for Connection<H, P>
where Arc<H>: Freeze, P: Freeze,

§

impl<H, P> Move for Connection<H, P>

§

impl<H, P> Send for Connection<H, P>
where P: Send, Arc<H>: Send,

§

impl<H, P> Unpin for Connection<H, P>
where P: Unpin, Arc<H>: Unpin,

§

impl<H, P> UnsafeUnpin for Connection<H, P>
where Arc<H>: UnsafeUnpin, P: 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> 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 = !

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