Struct fdir::file::FileInfo

pub struct FileInfo { /* private fields */ }

Implementations

impl FileInfo

pub fn open(path: impl AsRef<Path>) -> Result<FileInfo>

pub fn create(path: impl AsRef<Path>) -> Result<FileInfo>

pub fn file_stem(&self) -> Option<&OsStr>

file_stem

pub fn extension(&self) -> Option<&OsStr>

extension

pub fn set_extension(&mut self, ext: impl AsRef<OsStr>) -> Result<()>

set_extension

pub fn close(&mut self)

Close the file read-write stream

pub fn start_reading(&mut self) -> Result<()>

pub fn read(&mut self, len: usize) -> _Result<Vec<u8>>

Reads bytes of the specified length

Examples

use fdir::FileInfo;
use fdir::buffer::Error;

let mut f = FileInfo::create("foo.txt").unwrap();
f.start_writing().unwrap();
f.write("Hello world!").unwrap();

f.start_reading().unwrap();
let hello = f.read(5).unwrap();
assert_eq!(hello.as_slice(), b"Hello");

let world = f.read(6).unwrap();
assert_eq!(world.as_slice(), b" world");

let s = f.read(5).unwrap();
assert_eq!(s.as_slice(), b"!");

let eof = f.read(5);
assert!(eof.is_err());

pub fn read_to_end<T: ReadBuf>(&mut self) -> _Result<T>

Read all the remaining bytes and convert it to any type that implements ReadBuf

Examples

use fdir::FileInfo;
use fdir::buffer::Error;

let mut f = FileInfo::create("foo.txt").unwrap();
f.start_writing().unwrap();
f.write("1234567").unwrap();

f.start_reading().unwrap();
f.read(4).unwrap();

let n: i32 = f.read_to_end().unwrap();
assert_eq!(n, 567)

pub fn read_line<T: ReadBuf>(&mut self) -> _Result<T>

Read one line and convert it to any type that implements ReadBuf

Examples

use fdir::FileInfo;
use fdir::buffer::Error;

let mut f = FileInfo::create("foo.txt").unwrap();
f.start_writing().unwrap();
f.writeln("Hello").unwrap();
f.writeln("World").unwrap();

f.start_reading().unwrap();
let hello: String = f.read_line().unwrap();
let world: String = f.read_line().unwrap();
assert_eq!(hello.as_str(), "Hello");
assert_eq!(world.as_str(), "World");

pub fn read_until<T: ReadBuf>(&mut self, byte: u8) -> _Result<T>

Read all bytes into buf until the delimiter byte or EOF is reached and convert it to any type that implements ReadBuf

Examples

use fdir::FileInfo;
use fdir::buffer::Error;

let mut f = FileInfo::create("foo.txt").unwrap();
f.start_writing().unwrap();
f.write("Hello World !").unwrap();

f.start_reading().unwrap();
let hello: String = f.read_until(b' ').unwrap();
let world: String = f.read_until(b' ').unwrap();
let s: String = f.read_until(b' ').unwrap();
assert_eq!(hello.as_str(), "Hello");
assert_eq!(world.as_str(), "World");
assert_eq!(s.as_str(), "!")

pub fn truncate(&mut self) -> Result<()>

It will truncate the file to 0 length

pub fn start_writing(&mut self) -> Result<()>

pub fn write<T: AsRef<[u8]>>(&mut self, buf: T) -> _Result<()>

pub fn writeln<T: AsRef<[u8]>>(&mut self, buf: T) -> _Result<()>

pub fn write_end_with<T: AsRef<[u8]>>(&mut self, buf: T, end: u8) -> _Result<()>

Trait Implementations

impl Clone for FileInfo

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FileInfo

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

Formats the value using the given formatter.

impl Display for FileInfo

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

Formats the value using the given formatter.

impl FileAttr for FileInfo

fn eq(&self, other: &Self) -> bool

Ignore the file name and check that all bytes are equal

If both files have a length of 0, the return is always true.

fn as_path(&self) -> &Path

fn size(&self) -> u64

fn rename<T: AsRef<OsStr>>(&mut self, name: T) -> Result<()>

Rename a file or directory

fn copy_new<P: AsRef<Path>>(&self, path: P) -> RecoverResult<'_>

Copy a file or directory to a new destination path

fn move_new<P: AsRef<Path>>(&mut self, path: P) -> RecoverResult<'_>

Move a file or directory to a new destination path

fn file_name(&self) -> Option<&OsStr>

Returns None if the path is root directory

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

fn parent(&self) -> Option<DirectoryInfo>

Return None if the path is a root directory

fn permissions(&self) -> Result<Permissions>

fn set_permissions(&self, perm: Permissions) -> Result<()>

fn read_only(&self) -> Result<bool>

fn set_readonly(&self, readonly: bool) -> Result<()>

fn delete(self) -> Result<()>

fn copy_to<P: AsRef<Path>>(&self, path: P) -> RecoverResult<'_>

Copy a file or directory to a new directory

fn move_to<P: AsRef<Path>>(&mut self, path: P) -> RecoverResult<'_>

Move a file or directory to a new directory

impl From<File> for FileInfo

fn from(value: File) -> Self

Converts to this type from the input type.