Struct nix::sys::socket::MsgFlags
pub struct MsgFlags { /* fields hidden */ }Documentation
Flags for send/recv and their relatives
Implementations
impl MsgFlags
const MSG_WAITALL: Self = _
Receive operation blocks until the full amount of data can be returned. The function may return smaller amount of data if a signal is caught, an error or disconnect occurs.
const MSG_DONTWAIT: Self = _
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.
const MSG_CTRUNC: Self = _
Receive flags: Control Data was discarded (buffer too small)
const MSG_TRUNC: Self = _
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).
const MSG_ERRQUEUE: Self = _
This flag specifies that queued errors should be received from the socket error queue. (For more details, see recvfrom(2))
const MSG_CMSG_CLOEXEC: Self = _
pub const fn empty() -> Self
Returns an empty set of flags.
pub const fn all() -> Self
Returns the set containing all flags.
pub const fn bits(&Self) -> c_int
Returns the raw value of the flags currently stored.
pub const fn from_bits(bits: c_int) -> $crate::_core::option::Option<Self>
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) -> Self
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
pub const unsafe fn from_bits_unchecked(bits: c_int) -> Self
Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).
Safety
The caller of the bitflags! macro can chose to allow or
disallow extra bits for their bitflags type.
The caller of from_bits_unchecked() has to ensure that
all bits correspond to a defined flag or that extra bits
are valid for this bitflags type.
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: Self) -> bool
Returns true if there are flags common to both self and other.
pub const fn contains(&Self, other: Self) -> bool
Returns true if all of the flags in other are contained within self.
pub fn insert(&mut Self, other: Self)
Inserts the specified flags in-place.
pub fn remove(&mut Self, other: Self)
Removes the specified flags in-place.
pub fn toggle(&mut Self, other: Self)
Toggles the specified flags in-place.
pub fn set(
&mut Self,
other: Self,
value: bool
)
&mut Self,
other: Self,
value: bool
)
Inserts or removes the specified flags depending on the passed value.
#[must_use]
pub const fn intersection(Self, other: Self) -> Self
pub const fn intersection(Self, other: Self) -> Self
Returns the intersection between the flags in self and
other.
Specifically, the returned set contains only the flags which are
present in both self and other.
This is equivalent to using the & operator (e.g.
ops::BitAnd), as in flags & other.
#[must_use]
pub const fn union(Self, other: Self) -> Self
pub const fn union(Self, other: Self) -> Self
Returns the union of between the flags in self and other.
Specifically, the returned set contains all flags which are
present in either self or other, including any which are
present in both (see Self::symmetric_difference if that
is undesirable).
This is equivalent to using the | operator (e.g.
ops::BitOr), as in flags | other.
#[must_use]
pub const fn difference(Self, other: Self) -> Self
pub const fn difference(Self, other: Self) -> Self
Returns the difference between the flags in self and other.
Specifically, the returned set contains all flags present in
self, except for the ones present in other.
It is also conceptually equivalent to the “bit-clear” operation:
flags & !other (and this syntax is also supported).
This is equivalent to using the - operator (e.g.
ops::Sub), as in flags - other.
#[must_use]
pub const fn symmetric_difference(Self, other: Self) -> Self
pub const fn symmetric_difference(Self, other: Self) -> Self
Returns the symmetric difference between the flags
in self and other.
Specifically, the returned set contains the flags present which
are present in self or other, but that are not present in
both. Equivalently, it contains the flags present in exactly
one of the sets self and other.
This is equivalent to using the ^ operator (e.g.
ops::BitXor), as in flags ^ other.
#[must_use]
pub const fn complement(Self) -> Self
pub const fn complement(Self) -> Self
Returns the complement of this set of flags.
Specifically, the returned set contains all the flags which are
not set in self, but which are allowed for this type.
Alternatively, it can be thought of as the set difference
between Self::all() and self (e.g. Self::all() - self)
This is equivalent to using the ! operator (e.g.
ops::Not), as in !flags.
Trait Implementations
impl Binary for MsgFlags
fn fmt(&Self, f: &mut $crate::_core::fmt::Formatter<'_>) -> $crate::_core::fmt::Resultimpl BitAndAssign<MsgFlags> for MsgFlags
fn bitand_assign(&mut Self, other: Self)
Disables all flags disabled in the set.
impl BitOrAssign<MsgFlags> for MsgFlags
fn bitor_assign(&mut Self, other: Self)
Adds the set of flags.
impl BitXorAssign<MsgFlags> for MsgFlags
fn bitxor_assign(&mut Self, other: Self)
Toggles the set of flags.
impl Debug for MsgFlags
fn fmt(&Self, f: &mut $crate::_core::fmt::Formatter<'_>) -> $crate::_core::fmt::Resultimpl Extend<MsgFlags> for MsgFlags
fn extend<T: $crate::_core::iter::IntoIterator<Item = Self>>(&mut Self, iterator: T)impl FromIterator<MsgFlags> for MsgFlags
fn from_iter<T: $crate::_core::iter::IntoIterator<Item = Self>>(iterator: T) -> Selfimpl Hash for MsgFlags
fn hash<__H: $crate::hash::Hasher>(&Self, state: &mut __H) -> ()impl LowerHex for MsgFlags
fn fmt(&Self, f: &mut $crate::_core::fmt::Formatter<'_>) -> $crate::_core::fmt::Resultimpl Octal for MsgFlags
fn fmt(&Self, f: &mut $crate::_core::fmt::Formatter<'_>) -> $crate::_core::fmt::Resultimpl Ord for MsgFlags
fn cmp(&Self, other: &MsgFlags) -> $crate::cmp::Orderingimpl PartialOrd<MsgFlags> for MsgFlags
fn partial_cmp(&Self, other: &MsgFlags) -> $crate::option::Option<$crate::cmp::Ordering>impl StructuralEq for MsgFlagsimpl StructuralPartialEq for MsgFlagsimpl SubAssign<MsgFlags> for MsgFlags
fn sub_assign(&mut Self, other: Self)
Disables all flags enabled in the set.
impl UpperHex for MsgFlags
fn fmt(&Self, f: &mut $crate::_core::fmt::Formatter<'_>) -> $crate::_core::fmt::ResultAuto Trait Implementations
impl RefUnwindSafe for MsgFlagsimpl UnwindSafe for MsgFlagsBlanket Implementations
impl<T> BorrowMut<T> for T
where
T: ?Sized,
where
T: ?Sized,
fn borrow_mut(&mut Self) -> &mut T