Struct `OpenOptions`

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.

Generally speaking, when using OpenOptions, you'll first call OpenOptions::new, then chain calls to methods to set each option, then call OpenOptions::open, passing the path of the file you're trying to open. This will give you a io::Result with a File inside that you can further operate on.

Examples

Opening a file to read:

use std::fs::OpenOptions;

let file = OpenOptions::new().read(true).open("foo.txt");

Opening a file for both reading and writing, as well as creating it if it doesn't exist:

use std::fs::OpenOptions;

let file = OpenOptions::new()
            .read(true)
            .write(true)
            .create(true)
            .open("foo.txt");

Implementations

`impl OpenOptions`

fn new() -> Self

Creates a blank new set of options ready for configuration.

All options are initially set to false.

Examples

use std::fs::OpenOptions;

let mut options = OpenOptions::new();
let file = options.read(true).open("foo.txt");

fn read(self: &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.

Examples

use std::fs::OpenOptions;

let file = OpenOptions::new().read(true).open("foo.txt");

fn write(self: &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.

Examples

use std::fs::OpenOptions;

let file = OpenOptions::new().write(true).open("foo.txt");

fn append(self: &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).

Append mode guarantees that writes will be positioned at the current end of file, even when there are other processes or threads appending to the same file. This is unlike seek([SeekFrom]::End(0)) followed by write(), which has a race between seeking and writing during which another writer can write, with our write() overwriting their data.

Keep in mind that this does not necessarily guarantee that data appended by different processes or threads does not interleave. The amount of data accepted a single write() call depends on the operating system and file system. A successful write() is allowed to write only part of the given data, so even if you're careful to provide the whole message in a single call to write(), there is no guarantee that it will be written out in full. If you rely on the filesystem accepting the message in a single write, make sure that all data that belongs together is written in one operation. This can be done by concatenating strings before passing them to write().

If a file is opened with both read and append access, beware that after opening, and after every write, the position for reading may be set at the end of the file. So, before writing, save the current position (using Seek::stream_position), and restore it before the next read.

Note

This function doesn't create the file if it doesn't exist. Use the OpenOptions::create method to do so.

Examples

use std::fs::OpenOptions;

let file = OpenOptions::new().append(true).open("foo.txt");

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

Sets the option for truncating a previous file.

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

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

Examples

use std::fs::OpenOptions;

let file = OpenOptions::new().write(true).truncate(true).open("foo.txt");

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

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

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

See also [std::fs::write()][self::write] for a simple function to create a file with some given data.

Errors

If .create(true) is set without .write(true) or .append(true), calling open will fail with InvalidInput error.

Examples

use std::fs::OpenOptions;

let file = OpenOptions::new().write(true).create(true).open("foo.txt");

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

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

No file is allowed to exist at the target location, also no (dangling) symlink. In this way, if the call succeeds, the file returned is guaranteed to be new. If a file exists at the target location, creating a new file will fail with AlreadyExists or another error based on the situation. See OpenOptions::open for a non-exhaustive list of likely errors.

This option is useful because it is atomic. Otherwise between checking whether a file exists and creating a new one, the file may have been created by another process (a TOCTOU race condition / attack).

If .create_new(true) is set, .create() and .truncate() are ignored.

The file must be opened with write or append access in order to create a new file.

Examples

use std::fs::OpenOptions;

let file = OpenOptions::new().write(true)
                             .create_new(true)
                             .open("foo.txt");

fn open<P: AsRef<Path>>(self: &Self, path: P) -> io::Result<File>

Opens a file at path with the options specified by self.

Errors

This function will return an error under a number of different circumstances. Some of these error conditions are listed here, together with their io::ErrorKind. The mapping to io::ErrorKinds is not part of the compatibility contract of the function.

NotFound: The specified file does not exist and neither create or create_new is set.
NotFound: One of the directory components of the file path does not exist.
PermissionDenied: The user lacks permission to get the specified access rights for the file.
PermissionDenied: The user lacks permission to open one of the directory components of the specified path.
AlreadyExists: create_new was specified and the file already exists.
InvalidInput: Invalid combinations of open options (truncate without write access, create without write or append access, no access mode set, etc.).

The following errors don't match any existing io::ErrorKind at the moment:

One of the directory components of the specified file path was not, in fact, a directory.
Filesystem-level errors: full disk, write permission requested on a read-only file system, exceeded disk quota, too many open files, too long filename, too many symbolic links in the specified path (Unix-like systems only), etc.

Examples

use std::fs::OpenOptions;

let file = OpenOptions::new().read(true).open("foo.txt");

`impl Clone for OpenOptions`

fn clone(self: &Self) -> OpenOptions

`impl Debug for OpenOptions`

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

`impl Freeze for OpenOptions`

`impl OpenOptionsExt for crate::fs::OpenOptions`

fn access_mode(self: &mut Self, access: u32) -> &mut OpenOptions
fn share_mode(self: &mut Self, share: u32) -> &mut OpenOptions
fn custom_flags(self: &mut Self, flags: u32) -> &mut OpenOptions
fn attributes(self: &mut Self, attributes: u32) -> &mut OpenOptions
fn security_qos_flags(self: &mut Self, flags: u32) -> &mut OpenOptions
fn freeze_last_access_time(self: &mut Self, freeze: bool) -> &mut Self
fn freeze_last_write_time(self: &mut Self, freeze: bool) -> &mut Self

`impl OpenOptionsExt for crate::fs::OpenOptions`

fn custom_flags(self: &mut Self, flags: i32) -> &mut OpenOptions

`impl OpenOptionsExt for crate::fs::OpenOptions`

fn mode(self: &mut Self, mode: u32) -> &mut OpenOptions
fn custom_flags(self: &mut Self, flags: i32) -> &mut OpenOptions

`impl RefUnwindSafe for OpenOptions`

`impl Send for OpenOptions`

`impl Sync for OpenOptions`

`impl Unpin for OpenOptions`

`impl UnwindSafe for OpenOptions`

`impl<T> Any for OpenOptions`

fn type_id(self: &Self) -> TypeId

`impl<T> Borrow for OpenOptions`

fn borrow(self: &Self) -> &T

`impl<T> BorrowMut for OpenOptions`

fn borrow_mut(self: &mut Self) -> &mut T

`impl<T> CloneToUninit for OpenOptions`

unsafe fn clone_to_uninit(self: &Self, dest: *mut u8)

`impl<T> From for OpenOptions`

fn from(t: T) -> T: Returns the argument unchanged.

`impl<T> ToOwned for OpenOptions`

fn to_owned(self: &Self) -> T
fn clone_into(self: &Self, target: &mut T)

`impl<T, U> Into for OpenOptions`

fn into(self: Self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of [From]<T> for U chooses to do.

`impl<T, U> TryFrom for OpenOptions`

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

`impl<T, U> TryInto for OpenOptions`

fn try_into(self: Self) -> Result<U, <U as TryFrom<T>>::Error>