Struct nix::fcntl::OFlag

source ·
pub struct OFlag { /* private fields */ }
Expand description

Configuration options for opened files.

Implementations§

source§

impl OFlag

source

pub const O_ACCMODE: Self = _

Mask for the access mode of the file.

source

pub const O_APPEND: Self = _

Open the file in append-only mode.

source

pub const O_ASYNC: Self = _

Generate a signal when input or output becomes possible.

source

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.

source

pub const O_CREAT: Self = _

Create the file if it does not exist.

source

pub const O_DIRECT: Self = _

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

source

pub const O_DIRECTORY: Self = _

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

source

pub const O_DSYNC: Self = _

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

source

pub const O_EXCL: Self = _

Error out if a file was not created.

source

pub const O_FSYNC: Self = _

Same as O_SYNC.

source

pub const O_LARGEFILE: Self = _

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

source

pub const O_NOATIME: Self = _

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

source

pub const O_NOCTTY: Self = _

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

source

pub const O_NDELAY: Self = _

Same as O_NONBLOCK.

source

pub const O_NOFOLLOW: Self = _

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

source

pub const O_NONBLOCK: Self = _

When possible, open the file in nonblocking mode.

source

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.

source

pub const O_RDONLY: Self = _

Only allow reading.

This should not be combined with O_WRONLY or O_RDWR.

source

pub const O_RDWR: Self = _

Allow both reading and writing.

This should not be combined with O_WRONLY or O_RDONLY.

source

pub const O_RSYNC: Self = _

Similar to O_DSYNC but applies to reads instead.

source

pub const O_SYNC: Self = _

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

source

pub const O_TMPFILE: Self = _

Create an unnamed temporary file.

source

pub const O_TRUNC: Self = _

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

source

pub const O_WRONLY: Self = _

Only allow writing.

This should not be combined with O_RDONLY or O_RDWR.

source

pub const fn empty() -> Self

Returns an empty set of flags.

source

pub const fn all() -> Self

Returns the set containing all flags.

source

pub const fn bits(&self) -> c_int

Returns the raw value of the flags currently stored.

source

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.

source

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

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

source

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.

source

pub const fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

source

pub const fn is_all(&self) -> bool

Returns true if all flags are currently set.

source

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

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

source

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

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

source

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

Inserts the specified flags in-place.

source

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

Removes the specified flags in-place.

source

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

Toggles the specified flags in-place.

source

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

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

source

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.

source

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.

source

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.

source

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.

source

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§

source§

impl Binary for OFlag

source§

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

Formats the value using the given formatter. Read more
source§

impl BitAnd for OFlag

source§

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

Returns the intersection between the two sets of flags.

source§

type Output = OFlag

The resulting type after applying the & operator.
source§

impl BitAndAssign for OFlag

source§

fn bitand_assign(&mut self, other: Self)

Disables all flags disabled in the set.

source§

impl BitOr for OFlag

source§

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

Returns the union of the two sets of flags.

source§

type Output = OFlag

The resulting type after applying the | operator.
source§

impl BitOrAssign for OFlag

source§

fn bitor_assign(&mut self, other: Self)

Adds the set of flags.

source§

impl BitXor for OFlag

source§

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

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

source§

type Output = OFlag

The resulting type after applying the ^ operator.
source§

impl BitXorAssign for OFlag

source§

fn bitxor_assign(&mut self, other: Self)

Toggles the set of flags.

source§

impl Clone for OFlag

source§

fn clone(&self) -> OFlag

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for OFlag

source§

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

Formats the value using the given formatter. Read more
source§

impl Extend<OFlag> for OFlag

source§

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

Extends a collection with the contents of an iterator. Read more
source§

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)
Extends a collection with exactly one element.
source§

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. Read more
source§

impl FromIterator<OFlag> for OFlag

source§

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

Creates a value from an iterator. Read more
source§

impl Hash for OFlag

source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · source§

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

Feeds a slice of this type into the given Hasher. Read more
source§

impl LowerHex for OFlag

source§

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

Formats the value using the given formatter. Read more
source§

impl Not for OFlag

source§

fn not(self) -> Self

Returns the complement of this set of flags.

source§

type Output = OFlag

The resulting type after applying the ! operator.
source§

impl Octal for OFlag

source§

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

Formats the value using the given formatter. Read more
source§

impl Ord for OFlag

source§

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

This method returns an Ordering between self and other. Read more
1.21.0 · source§

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

Compares and returns the maximum of two values. Read more
1.21.0 · source§

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

Compares and returns the minimum of two values. Read more
1.50.0 · source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized + PartialOrd,

Restrict a value to a certain interval. Read more
source§

impl PartialEq for OFlag

source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl PartialOrd for OFlag

source§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · source§

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

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
source§

impl Sub for OFlag

source§

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

Returns the set difference of the two sets of flags.

source§

type Output = OFlag

The resulting type after applying the - operator.
source§

impl SubAssign for OFlag

source§

fn sub_assign(&mut self, other: Self)

Disables all flags enabled in the set.

source§

impl UpperHex for OFlag

source§

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

Formats the value using the given formatter. Read more
source§

impl Copy for OFlag

source§

impl Eq for OFlag

source§

impl StructuralPartialEq for OFlag

Auto Trait Implementations§

§

impl Freeze for OFlag

§

impl RefUnwindSafe for OFlag

§

impl Send for OFlag

§

impl Sync for OFlag

§

impl Unpin for OFlag

§

impl UnwindSafe for OFlag

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> CloneToUninit for T
where T: Clone,

source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for T
where T: Clone,

source§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

source§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.