Packet

Struct Packet 

Source
pub struct Packet<P, E>
where P: Handler<E>, E: Message,
{ /* private fields */ }
Expand description

Represents a packet that wraps a message and specifies its type and reply address.

The Packet struct is used to encapsulate a message of type E along with an optional reply address. It is generic over two type parameters:

  • P: The handler type that can handle the message type E.
  • E: The message type that implements the Message trait.

The packet can be created with or without a reply address using the provided constructor methods.

Implementations§

Source§

impl<P, E> Packet<P, E>
where P: Handler<E>, E: Message,

Source

pub fn without_reply(message: E) -> Self

Creates a new Packet without a reply address.

This method is a shorthand for creating a packet that does not expect a response.

§Returns

A new Packet instance containing the provided message and no reply address.

Source

pub fn with_reply( message: E, reply_address: Sender<Result<ResponseFor<P, E>, PuppetError>>, ) -> Self

Creates a new Packet with a reply address.

This method is a shorthand for creating a packet that expects a response.

§Returns

A new Packet instance containing the provided message and reply address.

Trait Implementations§

Source§

impl<P, E> Envelope<P> for Packet<P, E>
where P: Handler<E>, E: Message + 'static,

Source§

fn handle_message<'life0, 'life1, 'life2, 'async_trait>( &'life0 mut self, puppet: &'life1 mut P, ctx: &'life2 mut Context<P>, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Handles the message using the provided puppet and context.
Source§

fn reply_error<'life0, 'life1, 'async_trait>( &'life0 mut self, ctx: &'life1 Context<P>, err: PuppetError, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Sends an error as a response using the provided context.

Auto Trait Implementations§

§

impl<P, E> Freeze for Packet<P, E>
where E: Freeze,

§

impl<P, E> !RefUnwindSafe for Packet<P, E>

§

impl<P, E> Send for Packet<P, E>

§

impl<P, E> Sync for Packet<P, E>
where E: Sync,

§

impl<P, E> Unpin for Packet<P, E>
where E: Unpin, P: Unpin,

§

impl<P, E> !UnwindSafe for Packet<P, E>

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