Struct splitfile::OpenOptions

pub struct OpenOptions { /* fields omitted */ }

Options and flags which can be used to configure how a file is opened.

This builder mirrors the usage and options of fs::OpenOptions, and returns a SplitFile instance.

Implementations

impl OpenOptions

pub fn new() -> OpenOptions

Creates a blank set of options ready for configuartion.

All options are initially set to false.

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

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 OpenOptions

Sets the option for write access.

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

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

Sets the option for append mode.

This option, when true, means that writes will append to a file instead of overwriting previous contents.

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

Sets the option for trncating a previous file. This truncate the first volume, and delete all additional volume files using fs::remove_file.

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

Sets the option for creating a new file.

This option indicates whether a new file will be created if the file does not yet already exist.

In order for the file to be created, write or append access must be used.

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

Sets the option to always create a new file.

This option indicates whether a new file will be created. No file is allowed to exist at the target location, also no (dangling) symlink.

pub fn open<P: AsRef<Path>>(&self, path: P, volsize: u64) -> Result<SplitFile>

Opens a file at path with the options specified by self. Path refers to the path of the first volume. Volsize is the maximum size of each volume.

Trait Implementations

impl Clone for OpenOptions

pub fn clone(&self) -> OpenOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for OpenOptions

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

Formats the value using the given formatter.

impl Default for OpenOptions

pub fn default() -> OpenOptions

Returns the "default value" for a type.