Struct nix::fcntl::OFlag

pub struct OFlag { /* fields omitted */ }

Configuration options for opened files.

Methods

impl OFlag

pub const O_ACCMODE: OFlag

O_ACCMODE: OFlag = OFlag{bits: libc::O_ACCMODE,}

Mask for the access mode of the file.

pub const O_APPEND: OFlag

O_APPEND: OFlag = OFlag{bits: libc::O_APPEND,}

Open the file in append-only mode.

pub const O_ASYNC: OFlag

O_ASYNC: OFlag = OFlag{bits: libc::O_ASYNC,}

Generate a signal when input or output becomes possible.

pub const O_CLOEXEC: OFlag

O_CLOEXEC: OFlag = OFlag{bits: libc::O_CLOEXEC,}

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

O_CREAT: OFlag = OFlag{bits: libc::O_CREAT,}

Create the file if it does not exist.

pub const O_DIRECT: OFlag

O_DIRECT: OFlag = OFlag{bits: libc::O_DIRECT,}

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

pub const O_DIRECTORY: OFlag

O_DIRECTORY: OFlag = OFlag{bits: libc::O_DIRECTORY,}

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

pub const O_DSYNC: OFlag

O_DSYNC: OFlag = OFlag{bits: libc::O_DSYNC,}

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

pub const O_EXCL: OFlag

O_EXCL: OFlag = OFlag{bits: libc::O_EXCL,}

Error out if a file was not created.

pub const O_FSYNC: OFlag

O_FSYNC: OFlag = OFlag{bits: libc::O_FSYNC,}

Same as O_SYNC.

pub const O_LARGEFILE: OFlag

O_LARGEFILE: OFlag = OFlag{bits: libc::O_LARGEFILE,}

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

pub const O_NOATIME: OFlag

O_NOATIME: OFlag = OFlag{bits: libc::O_NOATIME,}

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

pub const O_NOCTTY: OFlag

O_NOCTTY: OFlag = OFlag{bits: libc::O_NOCTTY,}

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

pub const O_NDELAY: OFlag

O_NDELAY: OFlag = OFlag{bits: libc::O_NDELAY,}

Same as O_NONBLOCK.

pub const O_NOFOLLOW: OFlag

O_NOFOLLOW: OFlag = OFlag{bits: libc::O_NOFOLLOW,}

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

pub const O_NONBLOCK: OFlag

O_NONBLOCK: OFlag = OFlag{bits: libc::O_NONBLOCK,}

When possible, open the file in nonblocking mode.

pub const O_PATH: OFlag

O_PATH: OFlag = OFlag{bits: libc::O_PATH,}

Obtain a file descriptor for low-level access.

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

pub const O_RDONLY: OFlag

O_RDONLY: OFlag = OFlag{bits: libc::O_RDONLY,}

Only allow reading.

This should not be combined with O_WRONLY or O_RDWR.

pub const O_RDWR: OFlag

O_RDWR: OFlag = OFlag{bits: libc::O_RDWR,}

Allow both reading and writing.

This should not be combined with O_WRONLY or O_RDWR.

pub const O_RSYNC: OFlag

O_RSYNC: OFlag = OFlag{bits: libc::O_RSYNC,}

Similar to O_DSYNC but applies to reads instead.

pub const O_SYNC: OFlag

O_SYNC: OFlag = OFlag{bits: libc::O_SYNC,}

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

pub const O_TMPFILE: OFlag

O_TMPFILE: OFlag = OFlag{bits: libc::O_TMPFILE,}

Create an unnamed temporary file.

pub const O_TRUNC: OFlag

O_TRUNC: OFlag = OFlag{bits: libc::O_TRUNC,}

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

pub const O_WRONLY: OFlag

O_WRONLY: OFlag = OFlag{bits: libc::O_WRONLY,}

Only allow writing.

This should not be combined with O_RDONLY or O_RDWR.

pub fn empty() -> OFlag

Returns an empty set of flags.

pub fn all() -> OFlag

Returns the set containing all flags.

pub 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 fn from_bits_truncate(bits: c_int) -> OFlag

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

pub fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

pub fn is_all(&self) -> bool

Returns true if all flags are currently set.

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

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

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

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

This method tests for !=.

impl Eq for OFlag

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 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: &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 Ord for OFlag

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

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

Formats the value using the given formatter.

impl Binary for OFlag

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

Formats the value using the given formatter.

impl Octal for OFlag

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

Formats the value using the given formatter.

impl LowerHex for OFlag

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

Formats the value using the given formatter.

impl UpperHex for OFlag

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

Formats the value using the given formatter.

impl BitOr 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 for OFlag

fn bitor_assign(&mut self, other: OFlag)

Adds the set of flags.

impl BitXor 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 for OFlag

fn bitxor_assign(&mut self, other: OFlag)

Toggles the set of flags.

impl BitAnd 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 for OFlag

fn bitand_assign(&mut self, other: OFlag)

Disables all flags disabled in the set.

impl Sub 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 for OFlag

fn sub_assign(&mut self, other: OFlag)

Disables all flags enabled in the set.

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

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

Extends a collection with the contents of an iterator.

impl FromIterator<OFlag> for OFlag

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

Creates a value from an iterator.