Struct nix::fcntl::OFlag

pub struct OFlag { /* fields omitted */ }

Configuration options for opened files.

Implementations

impl OFlag

pub const O_ACCMODE: OFlag

Mask for the access mode of the file.

pub const O_APPEND: OFlag

Open the file in append-only mode.

pub const O_ASYNC: OFlag

Generate a signal when input or output becomes possible.

pub const O_CLOEXEC: OFlag

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: OFlag

Create the file if it does not exist.

pub const O_DIRECT: OFlag

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

pub const O_DIRECTORY: OFlag

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

pub const O_EXCL: OFlag

Error out if a file was not created.

pub const O_EXEC: OFlag

Open for execute only.

pub const O_EXLOCK: OFlag

Open with an exclusive file lock.

pub const O_FSYNC: OFlag

Same as O_SYNC.

pub const O_NOCTTY: OFlag

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

pub const O_NDELAY: OFlag

Same as O_NONBLOCK.

pub const O_NOFOLLOW: OFlag

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

pub const O_NONBLOCK: OFlag

When possible, open the file in nonblocking mode.

pub const O_RDONLY: OFlag

Only allow reading.

This should not be combined with O_WRONLY or O_RDWR.

pub const O_RDWR: OFlag

Allow both reading and writing.

This should not be combined with O_WRONLY or O_RDONLY.

pub const O_SHLOCK: OFlag

Open with a shared file lock.

pub const O_SYNC: OFlag

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

pub const O_TRUNC: OFlag

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

pub const O_TTY_INIT: OFlag

Restore default TTY attributes.

pub const O_WRONLY: OFlag

Only allow writing.

This should not be combined with O_RDONLY or O_RDWR.

pub const fn empty() -> OFlag

Returns an empty set of flags

pub const fn all() -> OFlag

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<OFlag>

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

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

pub const unsafe fn from_bits_unchecked(bits: c_int) -> OFlag

Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).

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: OFlag) -> bool

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

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

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

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

Inserts the specified flags in-place.

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

Removes the specified flags in-place.

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

Toggles the specified flags in-place.

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

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

Trait Implementations

impl Binary for OFlag

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

Formats the value using the given formatter.

impl BitAnd<OFlag> for OFlag

type Output = OFlag

The resulting type after applying the & operator.

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

Returns the intersection between the two sets of flags.

impl BitAndAssign<OFlag> for OFlag

fn bitand_assign(&mut self, other: OFlag)

Disables all flags disabled in the set.

impl BitOr<OFlag> for OFlag

type Output = OFlag

The resulting type after applying the | operator.

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

Returns the union of the two sets of flags.

impl BitOrAssign<OFlag> for OFlag

fn bitor_assign(&mut self, other: OFlag)

Adds the set of flags.

impl BitXor<OFlag> for OFlag

type Output = OFlag

The resulting type after applying the ^ operator.

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

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

impl BitXorAssign<OFlag> for OFlag

fn bitxor_assign(&mut self, other: OFlag)

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 Copy for OFlag

impl Debug for OFlag

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

Formats the value using the given formatter.

impl Eq for OFlag

impl Extend<OFlag> for OFlag

fn extend<T: IntoIterator<Item = OFlag>>(&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 = OFlag>>(iterator: T) -> OFlag

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, 

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

type Output = OFlag

The resulting type after applying the ! operator.

fn not(self) -> OFlag

Returns the complement of this set of flags.

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.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

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

Restrict a value to a certain interval.

impl PartialEq<OFlag> 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: &OFlag) -> bool

This method tests for !=.

impl PartialOrd<OFlag> 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: &OFlag) -> bool

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

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

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

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

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

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

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

impl StructuralEq for OFlag

impl StructuralPartialEq for OFlag

impl Sub<OFlag> for OFlag

type Output = OFlag

The resulting type after applying the - operator.

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

Returns the set difference of the two sets of flags.

impl SubAssign<OFlag> for OFlag

fn sub_assign(&mut self, other: OFlag)

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.