Enum FileMode 

#[non_exhaustive]
#[repr(u8)]
pub enum FileMode {
    Readonly = 0,
    Writable = 1,
}

Describes a mode by which a file may be manipulated.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Readonly = 0

A file mode that can only read from files.

Writable = 1

A file mode that can read from and write to files.

Implementations

impl FileMode

pub fn open<P: Into<PathBuf> + AsRef<Path>>(self, path: P) -> Result<File>

Opens a new File with file options based on this FileMode.

pub fn create<P: Into<PathBuf> + AsRef<Path>>(self, path: P) -> Result<File>

Opens a new File with file options based on this FileMode, or create it if it does not exist.

pub fn create_new<P: Into<PathBuf> + AsRef<Path>>(self, path: P) -> Result<File>

Creates a new File with file options based on this FileMode, failing if it already exists.

pub const fn can_read(self) -> bool

Returns true if this FileMode is allowed to read, false otherwise.

pub const fn can_write(self) -> bool

Returns true if this FileMode is allowed to write, false otherwise.

pub const fn must_read(self) -> Result<(), OtherError>

Throws an appropriate error if this FileMode is not allowed to read.

pub const fn must_write(self) -> Result<(), OtherError>

Throws an appropriate error if this FileMode is not allowed to write.

Trait Implementations

impl Clone for FileMode

fn clone(&self) -> FileMode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FileMode

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

Formats the value using the given formatter.

impl Default for FileMode

fn default() -> FileMode

Returns the “default value” for a type.

impl Hash for FileMode

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 Ord for FileMode

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

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

fn partial_cmp(&self, other: &FileMode) -> 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 Copy for FileMode

impl Eq for FileMode

impl StructuralPartialEq for FileMode