Struct nix::fcntl::OFlag
pub struct OFlag { /* fields hidden */ }Documentation
Configuration options for opened files.
Implementations
impl OFlag
const O_ACCMODE: Self = _
Mask for the access mode of the file.
const O_APPEND: Self = _
Open the file in append-only mode.
const O_ASYNC: Self = _
Generate a signal when input or output becomes possible.
const O_CLOEXEC: Self = _
Closes the file descriptor once an execve call is made.
Also sets the file offset to the beginning of the file.
const O_CREAT: Self = _
Create the file if it does not exist.
const O_DIRECT: Self = _
Try to minimize cache effects of the I/O for this file.
const O_DIRECTORY: Self = _
If the specified path isn’t a directory, fail.
const O_DSYNC: Self = _
Implicitly follow each write() with an fdatasync().
const O_EXCL: Self = _
Error out if a file was not created.
const O_FSYNC: Self = _
Same as O_SYNC.
const O_LARGEFILE: Self = _
Allow files whose sizes can’t be represented in an off_t to be opened.
const O_NOATIME: Self = _
Do not update the file last access time during read(2)s.
const O_NOCTTY: Self = _
Don’t attach the device as the process’ controlling terminal.
const O_NDELAY: Self = _
Same as O_NONBLOCK.
const O_NOFOLLOW: Self = _
open() will fail if the given path is a symbolic link.
const O_NONBLOCK: Self = _
When possible, open the file in nonblocking mode.
const O_PATH: Self = _
Obtain a file descriptor for low-level access.
The file itself is not opened and other file operations will fail.
const O_RDONLY: Self = _
Only allow reading.
This should not be combined with O_WRONLY or O_RDWR.
const O_RDWR: Self = _
Allow both reading and writing.
This should not be combined with O_WRONLY or O_RDONLY.
const O_RSYNC: Self = _
Similar to O_DSYNC but applies to reads instead.
const O_SYNC: Self = _
Implicitly follow each write() with an fsync().
const O_TMPFILE: Self = _
Create an unnamed temporary file.
const O_TRUNC: Self = _
Truncate an existing regular file to 0 length if it allows writing.
const O_WRONLY: Self = _
Only allow writing.
This should not be combined with O_RDONLY or O_RDWR.
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 OFlag
fn fmt(&Self, f: &mut $crate::_core::fmt::Formatter<'_>) -> $crate::_core::fmt::Resultimpl BitAndAssign<OFlag> for OFlag
fn bitand_assign(&mut Self, other: Self)
Disables all flags disabled in the set.
impl BitOrAssign<OFlag> for OFlag
fn bitor_assign(&mut Self, other: Self)
Adds the set of flags.
impl BitXorAssign<OFlag> for OFlag
fn bitxor_assign(&mut Self, other: Self)
Toggles the set of flags.
impl Debug for OFlag
fn fmt(&Self, f: &mut $crate::_core::fmt::Formatter<'_>) -> $crate::_core::fmt::Resultimpl Extend<OFlag> for OFlag
fn extend<T: $crate::_core::iter::IntoIterator<Item = Self>>(&mut Self, iterator: T)impl FromIterator<OFlag> for OFlag
fn from_iter<T: $crate::_core::iter::IntoIterator<Item = Self>>(iterator: T) -> Selfimpl Hash for OFlag
fn hash<__H: $crate::hash::Hasher>(&Self, state: &mut __H) -> ()impl LowerHex for OFlag
fn fmt(&Self, f: &mut $crate::_core::fmt::Formatter<'_>) -> $crate::_core::fmt::Resultimpl Octal for OFlag
fn fmt(&Self, f: &mut $crate::_core::fmt::Formatter<'_>) -> $crate::_core::fmt::Resultimpl Ord for OFlag
fn cmp(&Self, other: &OFlag) -> $crate::cmp::Orderingimpl PartialOrd<OFlag> for OFlag
fn partial_cmp(&Self, other: &OFlag) -> $crate::option::Option<$crate::cmp::Ordering>impl StructuralEq for OFlagimpl StructuralPartialEq for OFlagimpl SubAssign<OFlag> for OFlag
fn sub_assign(&mut Self, other: Self)
Disables all flags enabled in the set.
impl UpperHex for OFlag
fn fmt(&Self, f: &mut $crate::_core::fmt::Formatter<'_>) -> $crate::_core::fmt::ResultAuto Trait Implementations
impl RefUnwindSafe for OFlagimpl UnwindSafe for OFlagBlanket Implementations
impl<T> BorrowMut<T> for T
where
T: ?Sized,
where
T: ?Sized,
fn borrow_mut(&mut Self) -> &mut T