Struct bonsaidb::server::ConnectedClient

pub struct ConnectedClient<B = NoBackend>
where
    B: Backend,
{ /* private fields */ }

A connected database client.

Implementations

impl<B> ConnectedClient<B>

where B: Backend,

pub fn address(&self) -> &SocketAddr

Returns the address of the connected client.

pub fn transport(&self) -> &Transport

Returns the transport method the client is connected via.

pub fn connected(&self) -> bool

Returns true if the server still believes the client is connected.

pub fn send<Api>( &self, session: Option<&Session>, response: &<Api as Api>::Response ) -> Result<(), Error>

where Api: Api,

Sends a custom API response to the client.

pub async fn client_data( &self ) -> LockedClientDataGuard<'_, <B as Backend>::ClientData>

Returns a locked reference to the stored client data.

pub fn session(&self, session_id: Option<SessionId>) -> Option<Session>

Looks up an active authentication session by its unique id. None represents the unauthenticated session, and the result can be used to check what permissions are allowed by default.

pub fn all_sessions<C>(&self) -> C

where C: FromIterator<Session>,

Returns a collection of all active Sessions for this client.

pub async fn set_client_data(&self, data: <B as Backend>::ClientData)

Sets the associated data for this client.

Trait Implementations

impl<B> Clone for ConnectedClient<B>

where B: Backend,

fn clone(&self) -> ConnectedClient<B>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<B> Debug for ConnectedClient<B>

where B: Debug + Backend,

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

Formats the value using the given formatter.