AgentReply

Struct AgentReply 

Source
pub struct AgentReply;
Expand description

A utility namespace for creating standard return types for act_on message handlers.

Message handlers registered with ManagedAgent::act_on typically need to return a future that is boxed and pinned, specifically [FutureBox]. This struct provides helpers to create common future types that might be needed as part of that process.

It acts purely as a namespace and is not intended to be instantiated.

Implementations§

Source§

impl AgentReply

Source

pub fn immediate() -> Pin<Box<impl Future<Output = ()> + Sized>>

Creates an immediately resolving, no-operation future, boxed and pinned.

This is useful for message handlers that perform synchronous work or do not need to perform any asynchronous operations after processing the message.

§Returns

A Pin<Box<impl Future<Output=()>>> that completes immediately. This can often be coerced or converted into the required [FutureBox].

Source

pub fn from_async<F>(future: F) -> Pin<Box<F>>
where F: Future<Output = ()> + Sized,

Wraps an existing future into a Pin<Box<F>>.

This method takes any future F with Output=() and boxes and pins it. This is often a necessary step before potentially casting or using it where a [FutureBox] is expected, provided F meets the Send + Sync + 'static bounds.

§Type Parameters
  • F: The type of the input future. Must have Output=().
§Arguments
  • future: The future to be wrapped.
§Returns

A Pin<Box<F>> containing the provided future.

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