Struct nix::fcntl::OFlag

pub struct OFlag { /* private fields */ }

Configuration options for opened files.

Implementations

impl OFlag

pub const O_ACCMODE: Self = _

Mask for the access mode of the file.

pub const O_APPEND: Self = _

Open the file in append-only mode.

pub const O_ASYNC: Self = _

Generate a signal when input or output becomes possible.

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

pub const O_CREAT: Self = _

Create the file if it does not exist.

pub const O_DIRECT: Self = _

Try to minimize cache effects of the I/O for this file.

pub const O_DIRECTORY: Self = _

If the specified path isn’t a directory, fail.

pub const O_DSYNC: Self = _

Implicitly follow each write() with an fdatasync().

pub const O_EXCL: Self = _

Error out if a file was not created.

pub const O_FSYNC: Self = _

Same as O_SYNC.

pub const O_LARGEFILE: Self = _

Allow files whose sizes can’t be represented in an off_t to be opened.

pub const O_NOATIME: Self = _

Do not update the file last access time during read(2)s.

pub const O_NOCTTY: Self = _

Don’t attach the device as the process’ controlling terminal.

pub const O_NDELAY: Self = _

Same as O_NONBLOCK.

pub const O_NOFOLLOW: Self = _

open() will fail if the given path is a symbolic link.

pub const O_NONBLOCK: Self = _

When possible, open the file in nonblocking mode.

pub const O_PATH: Self = _

Obtain a file descriptor for low-level access.

The file itself is not opened and other file operations will fail.

pub const O_RDONLY: Self = _

Only allow reading.

This should not be combined with O_WRONLY or O_RDWR.

pub const O_RDWR: Self = _

Allow both reading and writing.

This should not be combined with O_WRONLY or O_RDONLY.

pub const O_RSYNC: Self = _

Similar to O_DSYNC but applies to reads instead.

pub const O_SYNC: Self = _

Implicitly follow each write() with an fsync().

pub const O_TMPFILE: Self = _

Create an unnamed temporary file.

pub const O_TRUNC: Self = _

Truncate an existing regular file to 0 length if it allows writing.

pub 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) -> 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)

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

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.

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.

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.

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.

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 Formatter<'_>) -> Result

Formats the value using the given formatter.

impl BitAnd for OFlag

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

Returns the intersection between the two sets of flags.

type Output = OFlag

The resulting type after applying the & operator.

impl BitAndAssign for OFlag

fn bitand_assign(&mut self, other: Self)

Disables all flags disabled in the set.

impl BitOr for OFlag

fn bitor(self, other: OFlag) -> Self

Returns the union of the two sets of flags.

type Output = OFlag

The resulting type after applying the | operator.

impl BitOrAssign for OFlag

fn bitor_assign(&mut self, other: Self)

Adds the set of flags.

impl BitXor for OFlag

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

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

type Output = OFlag

The resulting type after applying the ^ operator.

impl BitXorAssign for OFlag

fn bitxor_assign(&mut self, other: Self)

Toggles the set of flags.

impl Clone for OFlag

fn clone(&self) -> OFlag

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for OFlag

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

Formats the value using the given formatter.

impl Extend<OFlag> for OFlag

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

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

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

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

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

Reserves capacity in a collection for the given number of additional elements.

impl FromIterator<OFlag> for OFlag

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

Creates a value from an iterator.

impl Hash for OFlag

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl LowerHex for OFlag

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

Formats the value using the given formatter.

impl Not for OFlag

fn not(self) -> Self

Returns the complement of this set of flags.

type Output = OFlag

The resulting type after applying the ! operator.

impl Octal for OFlag

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

Formats the value using the given formatter.

impl Ord for OFlag

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for OFlag

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

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

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

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

impl PartialOrd for OFlag

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

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

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

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

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

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

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

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

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

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

impl Sub for OFlag

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

Returns the set difference of the two sets of flags.

type Output = OFlag

The resulting type after applying the - operator.

impl SubAssign 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 Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Copy for OFlag

impl Eq for OFlag

impl StructuralEq for OFlag

impl StructuralPartialEq for OFlag