Struct nix::sys::socket::MsgFlags

pub struct MsgFlags { /* fields omitted */ }

Flags for send/recv and their relatives

Methods

impl MsgFlags

pub const MSG_OOB: MsgFlags

Sends or requests out-of-band data on sockets that support this notion (e.g., of type Stream); the underlying protocol must also support out-of-band data.

pub const MSG_PEEK: MsgFlags

Peeks at an incoming message. The data is treated as unread and the next recv() or similar function shall still return this data.

pub const MSG_DONTWAIT: MsgFlags

Enables nonblocking operation; if the operation would block, EAGAIN or EWOULDBLOCK is returned. This provides similar behavior to setting the O_NONBLOCK flag (via the fcntl F_SETFL operation), but differs in that MSG_DONTWAIT is a per- call option, whereas O_NONBLOCK is a setting on the open file description (see open(2)), which will affect all threads in the calling process and as well as other processes that hold file descriptors referring to the same open file description.

pub const MSG_CTRUNC: MsgFlags

Receive flags: Control Data was discarded (buffer too small)

pub const MSG_TRUNC: MsgFlags

For raw (Packet), Internet datagram (since Linux 2.4.27/2.6.8), netlink (since Linux 2.6.22) and UNIX datagram (since Linux 3.4) sockets: return the real length of the packet or datagram, even when it was longer than the passed buffer. Not implemented for UNIX domain (unix(7)) sockets.

For use with Internet stream sockets, see tcp(7).

pub const MSG_EOR: MsgFlags

Terminates a record (when this notion is supported, as for sockets of type SeqPacket).

pub const MSG_ERRQUEUE: MsgFlags

This flag specifies that queued errors should be received from the socket error queue. (For more details, see recvfrom(2))

pub const MSG_CMSG_CLOEXEC: MsgFlags

Set the close-on-exec flag for the file descriptor received via a UNIX domain file descriptor using the SCM_RIGHTS operation (described in unix(7)). This flag is useful for the same reasons as the O_CLOEXEC flag of open(2).

Only used in recvmsg function.

pub const fn empty() -> MsgFlags

Returns an empty set of flags

pub const fn all() -> MsgFlags

Returns the set containing all flags.

pub const fn bits(&self) -> c_int

Returns the raw value of the flags currently stored.

pub fn from_bits(bits: c_int) -> Option<MsgFlags>

Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.

pub const fn from_bits_truncate(bits: c_int) -> MsgFlags

Convert from underlying bit representation, dropping any bits that do not correspond to flags.

pub const fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

pub const fn is_all(&self) -> bool

Returns true if all flags are currently set.

pub const fn intersects(&self, other: MsgFlags) -> bool

Returns true if there are flags common to both self and other.

pub const fn contains(&self, other: MsgFlags) -> bool

Returns true all of the flags in other are contained within self.

pub fn insert(&mut self, other: MsgFlags)

Inserts the specified flags in-place.

pub fn remove(&mut self, other: MsgFlags)

Removes the specified flags in-place.

pub fn toggle(&mut self, other: MsgFlags)

Toggles the specified flags in-place.

pub fn set(&mut self, other: MsgFlags, value: bool)

Inserts or removes the specified flags depending on the passed value.

Trait Implementations

impl Copy for MsgFlags

impl Eq for MsgFlags

impl Clone for MsgFlags

fn clone(&self) -> MsgFlags

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialOrd<MsgFlags> for MsgFlags

fn partial_cmp(&self, other: &MsgFlags) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &MsgFlags) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &MsgFlags) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &MsgFlags) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &MsgFlags) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Extend<MsgFlags> for MsgFlags

fn extend<T: IntoIterator<Item = MsgFlags>>(&mut self, iterator: T)

Extends a collection with the contents of an iterator.

impl PartialEq<MsgFlags> for MsgFlags

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Ord for MsgFlags

fn cmp(&self, other: &MsgFlags) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl Hash for MsgFlags

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl Debug for MsgFlags

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

Formats the value using the given formatter.

impl Sub<MsgFlags> for MsgFlags

type Output = MsgFlags

The resulting type after applying the - operator.

fn sub(self, other: MsgFlags) -> MsgFlags

Returns the set difference of the two sets of flags.

impl SubAssign<MsgFlags> for MsgFlags

fn sub_assign(&mut self, other: MsgFlags)

Disables all flags enabled in the set.

impl Not for MsgFlags

type Output = MsgFlags

The resulting type after applying the ! operator.

fn not(self) -> MsgFlags

Returns the complement of this set of flags.

impl BitAnd<MsgFlags> for MsgFlags

type Output = MsgFlags

The resulting type after applying the & operator.

fn bitand(self, other: MsgFlags) -> MsgFlags

Returns the intersection between the two sets of flags.

impl BitOr<MsgFlags> for MsgFlags

type Output = MsgFlags

The resulting type after applying the | operator.

fn bitor(self, other: MsgFlags) -> MsgFlags

Returns the union of the two sets of flags.

impl BitXor<MsgFlags> for MsgFlags

type Output = MsgFlags

The resulting type after applying the ^ operator.

fn bitxor(self, other: MsgFlags) -> MsgFlags

Returns the left flags, but with all the right flags toggled.

impl BitAndAssign<MsgFlags> for MsgFlags

fn bitand_assign(&mut self, other: MsgFlags)

Disables all flags disabled in the set.

impl BitOrAssign<MsgFlags> for MsgFlags

fn bitor_assign(&mut self, other: MsgFlags)

Adds the set of flags.

impl BitXorAssign<MsgFlags> for MsgFlags

fn bitxor_assign(&mut self, other: MsgFlags)

Toggles the set of flags.

impl FromIterator<MsgFlags> for MsgFlags

fn from_iter<T: IntoIterator<Item = MsgFlags>>(iterator: T) -> MsgFlags

Creates a value from an iterator.

impl Octal for MsgFlags

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

Formats the value using the given formatter.

impl Binary for MsgFlags

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

Formats the value using the given formatter.

impl LowerHex for MsgFlags

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

Formats the value using the given formatter.

impl UpperHex for MsgFlags

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

Formats the value using the given formatter.