## RecvFlags

# Struct RecvFlags

Source

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

Expand description

Flags for incoming messages.

Flags provide additional information about incoming messages.

## Implementations§

Source§

### impl RecvFlags

Unix-only API.

Source

#### 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.

Source

#### 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.

Source

#### pub const fn is_confirm(self) -> bool

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.

Source

#### pub const fn is_dontroute(self) -> bool

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.

Source§

### impl RecvFlags

Source

#### 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§

Source§

### impl Clone for RecvFlags

Source§

#### fn clone(&self) -> RecvFlags

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from `source`. Read more
Source§

### impl Debug for RecvFlags

Source§

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

Formats the value using the given formatter. Read more
Source§

### impl PartialEq for RecvFlags

Source§

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

Tests for `self` and `other` values to be equal, and is used by `==`.
1.0.0 · Source§

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

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

### impl Copy for RecvFlags

Source§

### impl Eq for RecvFlags

Source§

### impl StructuralPartialEq for RecvFlags

## Auto Trait Implementations§

§

### impl Freeze for RecvFlags

§

### impl RefUnwindSafe for RecvFlags

§

### impl Send for RecvFlags

§

### impl Sync for RecvFlags

§

### impl Unpin for RecvFlags

§

### impl UnwindSafe for RecvFlags

## 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> CloneToUninit for T
where T: Clone,

Source§

#### unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (`clone_to_uninit`)
Performs copy-assignment from `self` to `dest`. Read more
Source§

### impl<T> From<T> for T

Source§

#### fn from(t: T) -> T

Returns the argument unchanged.

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> ToOwned for T
where T: Clone,

Source§

#### type Owned = T

The resulting type after obtaining ownership.
Source§

#### fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

#### fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.