Struct RecvFlags

pub struct RecvFlags(/* private fields */);

Available on non-Redox only.

Flags for incoming messages.

Flags provide additional information about incoming messages.

Implementations

impl RecvFlags

Unix-only API.

pub const fn is_end_of_record(self) -> bool

Check if the message terminates a record.

Not all socket types support the notion of records. For socket types that do support it (such as SEQPACKET), a record is terminated by sending a message with the end-of-record flag set.

On Unix this corresponds to the MSG_EOR flag.

pub const fn is_out_of_band(self) -> bool

Check if the message contains out-of-band data.

This is useful for protocols where you receive out-of-band data mixed in with the normal data stream.

On Unix this corresponds to the MSG_OOB flag.

pub const fn is_confirm(self) -> bool

Available on crate feature all and (Android or Linux) only.

Check if the confirm flag is set.

This is used by SocketCAN to indicate a frame was sent via the socket it is received on. This flag can be interpreted as a ‘transmission confirmation’.

On Unix this corresponds to the MSG_CONFIRM flag.

pub const fn is_dontroute(self) -> bool

Available on crate feature all and (Android or Linux) only.

Check if the don’t route flag is set.

This is used by SocketCAN to indicate a frame was created on the local host.

On Unix this corresponds to the MSG_DONTROUTE flag.

impl RecvFlags

pub const fn is_truncated(self) -> bool

Check if the message contains a truncated datagram.

This flag is only used for datagram-based sockets, not for stream sockets.

On Unix this corresponds to the MSG_TRUNC flag. On Windows this corresponds to the WSAEMSGSIZE error code.

Trait Implementations

impl Clone for RecvFlags

fn clone(&self) -> RecvFlags

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RecvFlags

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for RecvFlags

fn eq(&self, other: &RecvFlags) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for RecvFlags

impl Eq for RecvFlags

impl StructuralPartialEq for RecvFlags

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 4 bytes