Skip to main content

DatagramContext

Struct DatagramContext 

Source
pub struct DatagramContext<W> { /* private fields */ }
Expand description

Context passed to a UDP crate::DatagramHandler.

Writes through this context are staged in a handler-local outbox. They are encoded into the socket’s pending datagram queue when the handler returns. They are sent only when Self::flush or a *_and_flush method requests an immediate flush. Dropping a flush handle is fire-and-forget; awaiting it waits until the local send_to calls complete.

Implementations§

Source§

impl<W: Send + 'static> DatagramContext<W>

Source

pub fn id(&self) -> u64

Socket id assigned by the UDP runtime.

Source

pub fn peer_addr(&self) -> SocketAddr

Peer address for the current datagram.

Source

pub fn local_addr(&self) -> SocketAddr

Local socket address.

Source

pub fn channel(&self) -> DatagramChannel<W>

Returns a cloneable channel for writing from outside the current handler.

Source

pub fn write(&mut self, msg: W) -> DatagramWriteHandle

Stages a response to the current datagram peer.

The message is stored in the handler-local outbox and later encoded into the socket’s pending datagram queue. It is not sent until the outbox or channel is explicitly flushed.

Source

pub fn write_to(&mut self, peer_addr: SocketAddr, msg: W) -> DatagramWriteHandle

Stages a datagram for an explicit peer.

Use this when a handler needs to reply somewhere other than the sender of the current datagram.

Source

pub fn flush(&mut self) -> DatagramFlushHandle<'_, W>

Sends messages staged by this handler so far.

Dropping the returned handle is fire-and-forget. Awaiting it waits until the socket task completes send_to for all staged messages before this flush boundary.

Source

pub fn write_and_flush(&mut self, msg: W) -> DatagramFlushHandle<'_, W>

Stages a response to the current peer and requests a flush.

Source

pub fn write_to_and_flush( &mut self, peer_addr: SocketAddr, msg: W, ) -> DatagramFlushHandle<'_, W>

Stages a datagram for an explicit peer and requests a flush.

Source

pub async fn close(&mut self) -> Result<()>

Requests that the socket task close after the current handler returns.

Auto Trait Implementations§

§

impl<W> Freeze for DatagramContext<W>

§

impl<W> RefUnwindSafe for DatagramContext<W>

§

impl<W> Send for DatagramContext<W>
where W: Send,

§

impl<W> Sync for DatagramContext<W>
where W: Send,

§

impl<W> Unpin for DatagramContext<W>

§

impl<W> UnsafeUnpin for DatagramContext<W>

§

impl<W> UnwindSafe for DatagramContext<W>

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