[][src]Struct tokio::fs::file::OpenOptions

pub struct OpenOptions(_);

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

This is a specialized version of std::fs::OpenOptions for usage from the Tokio runtime.

From<std::fs::OpenOptions> is implemented for more advanced configuration than the methods provided here.

Methods

impl OpenOptions[src]

pub fn new() -> OpenOptions[src]

Creates a blank new set of options ready for configuration.

All options are initially set to false.

Examples

This example is not tested
use tokio::fs::OpenOptions;

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

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

See the underlying read call for details.

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

See the underlying write call for details.

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

See the underlying append call for details.

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

See the underlying truncate call for details.

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

See the underlying create call for details.

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

See the underlying create_new call for details.

pub fn open<P>(&self, path: P) -> OpenFuture<P> where
    P: AsRef<Path> + Send + 'static, 
[src]

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

Errors

OpenOptionsFuture results in an error if called from outside of the Tokio runtime or if the underlying open call results in an error.

Trait Implementations

impl Clone for OpenOptions[src]

impl Debug for OpenOptions[src]

impl From<OpenOptions> 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
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

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

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

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

The type returned in the event of a conversion error.