Struct sgx_tstd::sgxfs::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 SgxFile is opened and what operations are permitted on the open file. The SgxFile::open and SgxFile::create methods are aliases for commonly used options using this builder.

Methods

impl OpenOptions

pub fn new() -> OpenOptions

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

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

Sets the option for update a previous file.

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

Sets the option for binary a file.

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

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

pub fn open_ex<P: AsRef<Path>>(
    &self,
    path: P,
    key: &sgx_key_128bit_t
) -> Result<SgxFile>

Trait Implementations

impl Debug for OpenOptions

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

Formats the value using the given formatter.

impl Clone for OpenOptions

fn clone(&self) -> OpenOptions

Returns a copy of the value.

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

Performs copy-assignment from source.