Skip to main content

ServerHook

Struct ServerHook 

Source
pub struct ServerHook<F> { /* private fields */ }
Expand description

Server-side authentication connection hook that validates incoming client tokens.

When a client connects, this connection hook:

  1. Waits for the client to send an auth token
  2. Validates the token using the provided validator function
  3. Sends an ACK on success, or rejects the connection on failure

§Example

use msg_socket::hooks::token::ServerHook;

// Accept all tokens
let hook = ServerHook::accept_all();

// Custom validation
let hook = ServerHook::new(|token| **token == *b"my_secret_token");

Implementations§

Source§

impl ServerHook<fn(&Bytes) -> bool>

Source

pub fn accept_all() -> Self

Creates a server hook that accepts all tokens.

Source§

impl<F> ServerHook<F>
where F: Fn(&Bytes) -> bool + Send + Sync + 'static,

Source

pub fn new(validator: F) -> Self

Creates a new server hook with the given validator function.

The validator receives the client’s token and returns true to accept the connection or false to reject it.

Trait Implementations§

Source§

impl<Io, F> ConnectionHook<Io> for ServerHook<F>
where Io: AsyncRead + AsyncWrite + Send + Unpin + 'static, F: Fn(&Bytes) -> bool + Send + Sync + 'static,

Source§

type Error = ServerHookError

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§

§

impl<F> Freeze for ServerHook<F>
where F: Freeze,

§

impl<F> RefUnwindSafe for ServerHook<F>
where F: RefUnwindSafe,

§

impl<F> Send for ServerHook<F>
where F: Send,

§

impl<F> Sync for ServerHook<F>
where F: Sync,

§

impl<F> Unpin for ServerHook<F>
where F: Unpin,

§

impl<F> UnsafeUnpin for ServerHook<F>
where F: UnsafeUnpin,

§

impl<F> UnwindSafe for ServerHook<F>
where F: 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> 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