Struct OpenOptions

pub struct OpenOptions {
    pub append: bool,
    pub create: bool,
    pub read: bool,
    pub truncate: bool,
    pub write: bool,
}

Options for opening a file. The default mode is read-only.

Fields

append: bool

True if the file should be able to be appended to.

create: bool

True if the file should be created if not present.

read: bool

True if the file should be able to be read.

truncate: bool

True if the file should be truncated.

write: bool

True if the file should be written to.

Implementations

impl OpenOptions

pub fn append(self, append: bool) -> Self

Arguments

append: If true, the file should be opened with the cursor set to the end of the file, rather than overwriting the file contents. Note that setting this to true will implicitly enable writing.

pub fn create(self, create: bool) -> Self

Arguments

append: If true, the file should be created if it does not exist. Note that setting this to true will implicitly enable writing.

pub fn read(self, read: bool) -> Self

Arguments

read: If true, the file should be able to be read in entirety.

pub fn truncate(self, truncate: bool) -> Self

Arguments

truncate: If true, the file should be opened with the cursor set to the beginning of the file, overwriting all contents. Note that setting this to true will implicitly enable writing.

pub fn write(self, write: bool) -> Self

Arguments

write: If true, the file should be able to be written. By default, this will truncate the contents of the file, unless append is set.

Trait Implementations

impl Debug for OpenOptions

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

Formats the value using the given formatter.

impl Default for OpenOptions

fn default() -> Self

Returns the “default value” for a type.

impl From<&OpenOptions> for OpenOptions

fn from(value: &OpenOptions) -> Self

Converts to this type from the input type.