Struct OpenOptions

pub struct OpenOptions { /* private fields */ }

Available on crate feature tokio only.

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

This is a wrapper around tokio::fs::OpenOptions.

Implementations

impl OpenOptions

pub fn new() -> OpenOptions

Creates a blank new set of options ready for configuration.

All options are initially set to false.

This is a wrapped version of tokio::fs::OpenOptions::new

Examples

use fs_err::tokio::OpenOptions;

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

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

Sets the option for read access.

Wrapper for tokio::fs::OpenOptions::read.

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

Sets the option for write access.

Wrapper for tokio::fs::OpenOptions::write.

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

Sets the option for the append mode.

Wrapper for tokio::fs::OpenOptions::append.

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

Sets the option for truncating a previous file.

Wrapper for tokio::fs::OpenOptions::truncate.

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

Sets the option for creating a new file.

Wrapper for tokio::fs::OpenOptions::create.

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

Sets the option to always create a new file.

Wrapper for tokio::fs::OpenOptions::create_new.

pub async fn open(&self, path: impl AsRef<Path>) -> Result<File>

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

Wrapper for tokio::fs::OpenOptions::open.

impl OpenOptions

pub fn mode(&mut self, mode: u32) -> &mut OpenOptions

Sets the mode bits that a new file will be created with.

Wrapper for tokio::fs::OpenOptions::mode.

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

Passes custom flags to the flags argument of open.

Wrapper for tokio::fs::OpenOptions::custom_flags.

Trait Implementations

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.

impl Debug for OpenOptions

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

Formats the value using the given formatter.

impl Default for OpenOptions

fn default() -> OpenOptions

Returns the “default value” for a type.

impl From<OpenOptions> for OpenOptions

fn from(std: OpenOptions) -> Self

Converts to this type from the input type.

impl From<OpenOptions> for OpenOptions

fn from(tokio: TokioOpenOptions) -> Self

Converts to this type from the input type.