[][src]Struct sgx_tstd::untrusted::fs::OpenOptions

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.

Generally speaking, when using OpenOptions, you'll first call new, then chain calls to methods to set each option, then call 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.


impl OpenOptions[src]

pub fn new() -> Self[src]

Creates a blank new set of options ready for configuration.

All options are initially set to false.

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

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[src]

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[src]

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).

For most filesystems, the operating system guarantees that all writes are atomic: no writes get mangled because another process writes at the same time.

One maybe obvious note when using append-mode: make sure that all data that belongs together is written to the file in one operation. This can be done by concatenating strings before passing them to write(), or using a buffered writer (with a buffer of adequate size), and calling flush() when the message is complete.

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(SeekFrom::Current(0))), and restore it before the next read.


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

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

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[src]

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

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 Self[src]

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.

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.

pub fn open<P: AsRef<Path>>(&self, path: P) -> Result<File>[src]

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


This function will return an error under a number of different circumstances. Some of these error conditions are listed here, together with their [ErrorKind]. The mapping to [ErrorKind]s is not part of the compatibility contract of the function, especially the Other kind might change to more specific kinds in the future.

  • [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, no access mode set, etc.).
  • [Other]: One of the directory components of the specified file path was not, in fact, a directory.
  • [Other]: 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.

Trait Implementations

impl Clone for OpenOptions[src]

impl Debug for OpenOptions[src]

impl OpenOptionsExt for OpenOptions[src]

Auto Trait Implementations

impl RefUnwindSafe for OpenOptions

impl Send for OpenOptions

impl Sync for OpenOptions

impl Unpin for OpenOptions

impl UnwindSafe for OpenOptions

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized

impl<T> Borrow<T> for T where
    T: ?Sized

impl<T> BorrowMut<T> for T where
    T: ?Sized

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 

impl<T> ToOwned for T where
    T: Clone

type Owned = T

The resulting type after obtaining ownership.

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.