Skip to main content

ClientHook

Struct ClientHook 

Source
pub struct ClientHook { /* private fields */ }
Expand description

Client-side authentication connection hook that sends a token to the server.

When connecting to a server, this connection hook:

  1. Sends the configured token to the server
  2. Waits for the server’s ACK response
  3. Returns an error if the server rejects the token

§Example

use bytes::Bytes;
use msg_socket::hooks::token::ClientHook;

let hook = ClientHook::new(Bytes::from("my_secret_token"));

Implementations§

Source§

impl ClientHook

Source

pub fn new(token: Bytes) -> Self

Creates a new client hook with the given authentication token.

Trait Implementations§

Source§

impl<Io> ConnectionHook<Io> for ClientHook
where Io: AsyncRead + AsyncWrite + Send + Unpin + 'static,

Source§

type Error = ClientHookError

The hook-specific error type.
Source§

async fn on_connection(&self, io: Io) -> HookResult<Io, Self::Error>

Called when a connection is established. Read more

Auto Trait Implementations§

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> SpanExt<T> for T

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