Struct std::fs::OpenOptionsUnstable
[-] [+]
[src]
pub struct OpenOptions(_);
Options and flags which can be used to configure how a file is opened.
This builder exposes the ability to configure how a File is opened and
what operations are permitted on the open file. The File::open and
File::create methods are aliases for commonly used options using this
builder.
Methods
impl OpenOptions
fn new() -> OpenOptions
Creates a blank net set of options ready for configuration.
All options are initially set to false.
fn read(&mut self, read: bool) -> &mut OpenOptions
Set the option for read access.
This option, when true, will indicate that the file should be
read-able if opened.
fn write(&mut self, write: bool) -> &mut OpenOptions
Set the option for write access.
This option, when true, will indicate that the file should be
write-able if opened.
fn append(&mut self, append: bool) -> &mut OpenOptions
Set the option for the append mode.
This option, when true, means that writes will append to a file instead of overwriting previous contents.
fn truncate(&mut self, truncate: bool) -> &mut OpenOptions
Set 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.
fn create(&mut self, create: bool) -> &mut OpenOptions
Set 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.
fn open<P: AsPath + ?Sized>(&self, path: &P) -> Result<File>
Open a file at path with the options specified by self.
Errors
This function will return an error under a number of different circumstances, to include but not limited to:
- Opening a file that does not exist with read access.
- Attempting to open a file with access that the user lacks permissions for
- Filesystem-level errors (full disk, etc)