Struct virtual_fs::OpenOptions

pub struct OpenOptions<'a> {
    pub(crate) opener: &'a dyn FileOpener,
    pub(crate) conf: OpenOptionsConfig,
}

Fields

opener: &'a dyn FileOpener

conf: OpenOptionsConfig

Implementations

impl<'a> OpenOptions<'a>

pub fn new(opener: &'a dyn FileOpener) -> Self

pub fn get_config(&self) -> OpenOptionsConfig

pub fn options(&mut self, options: OpenOptionsConfig) -> &mut Self

Use an existing OpenOptionsConfig to configure this OpenOptions.

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

Sets the option for read access.

This option, when true, will indicate that the file should be read-able if opened.

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

Sets the option for write access.

This option, when true, will indicate that the file should be write-able if opened.

If the file already exists, any write calls on it will overwrite its contents, without truncating it.

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

Sets the option for the append mode.

This option, when true, means that writes will append to a file instead of overwriting previous contents. Note that setting .write(true).append(true) has the same effect as setting only .append(true).

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

Sets the option for truncating a previous file.

If a file is successfully opened with this option set it will truncate the file to 0 length if it already exists.

The file must be opened with write access for truncate to work.

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

Sets the option to create a new file, or open it if it already exists.

pub fn create_new(&mut self, create_new: bool) -> &mut Self

Sets the option to create a new file, failing if it already exists.

pub fn open<P: AsRef<Path>>( &mut self, path: P, ) -> Result<Box<dyn VirtualFile + Send + Sync + 'static>>

Trait Implementations

impl<'a> Debug for OpenOptions<'a>

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

Formats the value using the given formatter.