Struct FileOpen

pub struct FileOpen { /* private fields */ }

INTERNAL TYPE: do not use directly.

Use FileRead, FileWrite or FileEdit instead.

Implementations

impl FileOpen

pub fn open<P: AsRef<Path>>(path: P, options: OpenOptions) -> Result<FileOpen>

Open the file with the given OpenOptions.

pub fn open_abs<P: Into<PathAbs>>( path: P, options: OpenOptions, ) -> Result<FileOpen>

Shortcut to open the file if the path is already absolute.

Typically you should use PathFile::open instead (i.e. file.open(options) or file.read()).

pub fn path(&self) -> &PathFile

Get the path associated with the open file.

pub fn metadata(&self) -> Result<Metadata>

Queries metadata about the underlying file.

This function is identical to std::fs::File::metadata except it has error messages which include the action and the path.

pub fn try_clone(&self) -> Result<FileOpen>

Creates a new independently owned handle to the underlying file.

This function is identical to std::fs::File::try_clone except it has error messages which include the action and the path and it returns a FileOpen object.

Trait Implementations

impl AsRef<File> for FileOpen

fn as_ref(&self) -> &File

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<FileOpen> for FileEdit

fn as_ref(&self) -> &FileOpen

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<FileOpen> for FileRead

fn as_ref(&self) -> &FileOpen

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<FileOpen> for FileWrite

fn as_ref(&self) -> &FileOpen

Converts this type into a shared reference of the (usually inferred) input type.

impl<'a> Borrow<File> for &'a FileOpen

fn borrow(&self) -> &File

Immutably borrows from an owned value.

impl Borrow<File> for FileOpen

fn borrow(&self) -> &File

Immutably borrows from an owned value.

impl<'a> Borrow<FileOpen> for &'a FileEdit

fn borrow(&self) -> &FileOpen

Immutably borrows from an owned value.

impl<'a> Borrow<FileOpen> for &'a FileRead

fn borrow(&self) -> &FileOpen

Immutably borrows from an owned value.

impl<'a> Borrow<FileOpen> for &'a FileWrite

fn borrow(&self) -> &FileOpen

Immutably borrows from an owned value.

impl Borrow<FileOpen> for FileEdit

fn borrow(&self) -> &FileOpen

Immutably borrows from an owned value.

impl Borrow<FileOpen> for FileRead

fn borrow(&self) -> &FileOpen

Immutably borrows from an owned value.

impl Borrow<FileOpen> for FileWrite

fn borrow(&self) -> &FileOpen

Immutably borrows from an owned value.

impl Debug for FileOpen

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

Formats the value using the given formatter.

impl From<FileEdit> for FileOpen

fn from(orig: FileEdit) -> FileOpen

Converts to this type from the input type.

impl From<FileOpen> for File

fn from(orig: FileOpen) -> File

Converts to this type from the input type.

impl From<FileRead> for FileOpen

fn from(orig: FileRead) -> FileOpen

Converts to this type from the input type.

impl From<FileWrite> for FileOpen

fn from(orig: FileWrite) -> FileOpen

Converts to this type from the input type.