Struct FileOpenMode 

pub struct FileOpenMode { /* private fields */ }

Available on crate feature fs or docsrs only.

A bitmask for open file.

See open_file for more information.

Implementations

impl FileOpenMode

pub const Append: FileOpenMode

Available on crate feature fs only.

Configures the option for append mode.

When set to true, this option means the file will be writable after opening and the file cursor will be moved to the end of file before every write operaiton.

pub const Writable: FileOpenMode

Available on crate feature fs only.

Configures the option for write mode. If the file already exists, write calls on it will overwrite the previous contents without truncating it.

pub const Readable: FileOpenMode

Available on crate feature fs only.

Configures the option for read mode. When set to true, this option means the file will be readable after opening.

pub const Create: FileOpenMode

Available on crate feature fs only.

Configures the option for creating a new file if it doesn’t exist. When set to true, this option means a new file will be created if it doesn’t exist. The file must be opened in Writable or Append mode for file creation to work.

pub const CreateNew: FileOpenMode

Available on crate feature fs only.

Configures the option for creating a new file or failing if it already exists. When set to true, this option means a new file will be created, or the open operation will fail if the file already exists. The file must be opened in Writable or Append mode for file creation to work.

pub const Truncate: FileOpenMode

Available on crate feature fs only.

Configures the option for truncating the previous file. When set to true, the file will be truncated to the length of 0 bytes. The file must be opened in Writable or Append mode for file creation to work.

pub const fn bits(&self) -> u8

Available on crate feature fs only.

Returns the underlying bits of the bitmask.

pub const fn all_bits() -> Self

Available on crate feature fs only.

Returns a bitmask that contains all values.

This will include bits that do not have any flags. Use ::all_flags() if you only want to use flags.

pub const fn all_flags() -> Self

Available on crate feature fs only.

Returns a bitmask that contains all flags.

pub const fn is_all_bits(&self) -> bool

Available on crate feature fs only.

Returns true if the bitmask contains all values.

This will check for bits == !0, use .is_all_flags() if you only want to check for all flags

pub const fn is_all_flags(&self) -> bool

Available on crate feature fs only.

Returns true if the bitmask contains all flags.

This will fail if any unused bit is set, consider using .truncate() first.

pub const fn all() -> Self

👎Deprecated: Please use the ::all_bits() constructor

Available on crate feature fs only.

Returns a bitmask that contains all values.

This will include bits that do not have any flags. Use ::all_flags() if you only want to use flags.

pub const fn is_all(&self) -> bool

👎Deprecated: Please use the .is_all_bits() method

Available on crate feature fs only.

Returns true if the bitmask contains all values.

This will check for bits == !0, use .is_all_flags() if you only want to check for all flags

pub const fn full() -> Self

👎Deprecated: Please use the ::all_flags() constructor

Available on crate feature fs only.

Returns a bitmask that contains all flags.

pub const fn is_full(&self) -> bool

👎Deprecated: Please use the .is_all_flags() method

Available on crate feature fs only.

Returns true if the bitmask contains all flags.

This will fail if any unused bit is set, consider using .truncate() first.

pub const fn none() -> Self

Available on crate feature fs only.

Returns a bitmask that does not contain any values.

pub const fn is_none(&self) -> bool

Available on crate feature fs only.

Returns true if the bitmask does not contain any values.

pub const fn truncate(&self) -> Self

Available on crate feature fs only.

Returns a bitmask that only has bits corresponding to flags

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

Available on crate feature fs only.

Returns true if self intersects with any value in other, or if other does not contain any values.

This is equivalent to (self & other) != 0 || other == 0.

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

Available on crate feature fs only.

Returns true if self contains all values of other.

This is equivalent to (self & other) == other.

pub const fn not(self) -> Self

Available on crate feature fs only.

Returns the bitwise NOT of the bitmask.

pub const fn and(self, other: Self) -> Self

Available on crate feature fs only.

Returns the bitwise AND of the bitmask.

pub const fn or(self, other: Self) -> Self

Available on crate feature fs only.

Returns the bitwise OR of the bitmask.

pub const fn xor(self, other: Self) -> Self

Available on crate feature fs only.

Returns the bitwise XOR of the bitmask.

Trait Implementations

impl Binary for FileOpenMode

Available on crate feature fs only.

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

Formats the value using the given formatter.

impl BitAnd for FileOpenMode

Available on crate feature fs only.

type Output = FileOpenMode

The resulting type after applying the & operator.

fn bitand(self, rhs: Self) -> Self::Output

Performs the & operation.

impl BitAndAssign for FileOpenMode

Available on crate feature fs only.

fn bitand_assign(&mut self, rhs: Self)

Performs the &= operation.

impl BitOr for FileOpenMode

Available on crate feature fs only.

type Output = FileOpenMode

The resulting type after applying the | operator.

fn bitor(self, rhs: Self) -> Self::Output

Performs the | operation.

impl BitOrAssign for FileOpenMode

Available on crate feature fs only.

fn bitor_assign(&mut self, rhs: Self)

Performs the |= operation.

impl BitXor for FileOpenMode

Available on crate feature fs only.

type Output = FileOpenMode

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: Self) -> Self::Output

Performs the ^ operation.

impl BitXorAssign for FileOpenMode

Available on crate feature fs only.

fn bitxor_assign(&mut self, rhs: Self)

Performs the ^= operation.

impl Clone for FileOpenMode

Available on crate feature fs only.

fn clone(&self) -> FileOpenMode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FileOpenMode

Available on crate feature fs only.

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

Formats the value using the given formatter.

impl From<FileOpenMode> for u8

Available on crate feature fs only.

fn from(val: FileOpenMode) -> u8

Converts to this type from the input type.

impl From<u8> for FileOpenMode

Available on crate feature fs only.

fn from(val: u8) -> Self

Converts to this type from the input type.

impl Hash for FileOpenMode

Available on crate feature fs only.

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 FileOpenMode

Available on crate feature fs only.

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

Formats the value using the given formatter.

impl Not for FileOpenMode

Available on crate feature fs only.

type Output = FileOpenMode

The resulting type after applying the ! operator.

fn not(self) -> Self::Output

Performs the unary ! operation.

impl Octal for FileOpenMode

Available on crate feature fs only.

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

Formats the value using the given formatter.

impl Ord for FileOpenMode

Available on crate feature fs only.

fn cmp(&self, other: &FileOpenMode) -> 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,

Restrict a value to a certain interval.

impl PartialEq<u8> for FileOpenMode

Available on crate feature fs only.

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialEq for FileOpenMode

Available on crate feature fs only.

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for FileOpenMode

Available on crate feature fs only.

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl UpperHex for FileOpenMode

Available on crate feature fs only.

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

Formats the value using the given formatter.

impl Copy for FileOpenMode

Available on crate feature fs only.

impl Eq for FileOpenMode

Available on crate feature fs only.

impl StructuralPartialEq for FileOpenMode

Available on crate feature fs only.