Skip to main content

SocketRecvMessage

base_scheduler

Trait SocketRecvMessage 

Source 
pub trait SocketRecvMessage: Send + 'static {
    type Payload: IoBuf;

    // Required methods
    fn address(&self) -> Option<impl SocketAddressView + '_>;
    fn payload(&self) -> &[u8] ⓘ;
    fn truncated(&self) -> bool;
    fn control_truncated(&self) -> bool;
    fn into_payload(self) -> Self::Payload;
}
Expand description

An owned received stream chunk or datagram, with backend-associated payload storage and metadata. The message may move between workers and outlive its receiver and scheduler. Its accessors describe contents and ownership, without prescribing allocation, copying, registration, or receive strategy.

Address views borrow the message and cannot survive extraction of its payload:

ⓘ
use base_scheduler::{OwnedSocketRecvMessage, SocketAddressView, SocketRecvMessage, SocketRecvResult};
let message = OwnedSocketRecvMessage::new(SocketRecvResult {
    bytes: 1, address: Some("127.0.0.1:1234".parse().unwrap()),
    truncated: false, control_truncated: false,
}, vec![0]);
let address = message.address().unwrap();
let payload = message.into_payload();
let endpoint = address.to_socket_address();

Required Associated Types§

Source

type Payload: IoBuf

The independently owned storage returned by into_payload.

Required Methods§

Source

fn address(&self) -> Option<impl SocketAddressView + '_>

The source endpoint when supplied by the receive operation. Stream chunks may have no address; use socket_peer_address for the connected peer. The view’s lifetime is bounded by this message. Its representation and any conversion costs are implementation details.

Source

fn payload(&self) -> &[u8] ⓘ

Exactly the completed payload. Empty datagrams expose an empty slice. Headers, source-address storage, ancillary metadata, and unused capacity are outside this range.

Source

fn truncated(&self) -> bool

Whether a datagram exceeded the supplied payload capacity. The exposed bytes are the received prefix, not the original datagram length.

Source

fn control_truncated(&self) -> bool

Whether the receive discarded ancillary data. This interface does not expose a control buffer.

Source

fn into_payload(self) -> Self::Payload

Consume the message and return independently owned storage exposing the same payload bytes and range as payload(), including any modifications through SocketRecvMessageMut. The owner can be passed to owned I/O or retained after receiver shutdown. Address views cannot outlive this transfer.

Dyn Compatibility§

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementors§