Struct Ext4

pub struct Ext4(/* private fields */);

Read-only access to an ext4 filesystem.

Implementations

impl Ext4

pub fn load(reader: Box<dyn Ext4Read>) -> Result<Self, Ext4Error>

Load an Ext4 instance from the given reader.

This reads and validates the superblock and block group descriptors. No other data is read.

pub fn load_from_path<P: AsRef<Path>>(path: P) -> Result<Self, Ext4Error>

Available on crate feature std only.

Load an Ext4 filesystem from the given path.

This reads and validates the superblock and block group descriptors. No other data is read.

impl Ext4

These methods mirror the std::fs API.

pub fn canonicalize<'p, P>(&self, path: P) -> Result<PathBuf, Ext4Error>

where P: TryInto<Path<'p>>,

Get the canonical, absolute form of a path with all intermediate components normalized and symbolic links resolved.

Errors

An error will be returned if:

• path is not absolute.
• path does not exist.

This is not an exhaustive list of errors, see the crate documentation.

pub fn read<'p, P>(&self, path: P) -> Result<Vec<u8>, Ext4Error>

where P: TryInto<Path<'p>>,

Read the entire contents of a file as raw bytes.

Errors

An error will be returned if:

• path is not absolute.
• path does not exist.
• path is a directory or special file type.

This is not an exhaustive list of errors, see the crate documentation.

pub fn read_to_string<'p, P>(&self, path: P) -> Result<String, Ext4Error>

where P: TryInto<Path<'p>>,

Read the entire contents of a file as a string.

Errors

An error will be returned if:

• path is not absolute.
• path does not exist.
• path is a directory or special file type.

This is not an exhaustive list of errors, see the crate documentation.

pub fn read_link<'p, P>(&self, path: P) -> Result<PathBuf, Ext4Error>

where P: TryInto<Path<'p>>,

Get the target of a symbolic link.

The final component of path must be a symlink. If the path contains any symlinks in components prior to the end, they will be fully resolved as normal.

Errors

An error will be returned if:

• path is not absolute.
• The final component of path is not a symlink.

This is not an exhaustive list of errors, see the crate documentation.

pub fn read_dir<'p, P>(&self, path: P) -> Result<ReadDir, Ext4Error>

where P: TryInto<Path<'p>>,

Get an iterator over the entries in a directory.

Errors

An error will be returned if:

• path is not absolute.
• path does not exist
• path is not a directory

This is not an exhaustive list of errors, see the crate documentation.

pub fn exists<'p, P>(&self, path: P) -> Result<bool, Ext4Error>

where P: TryInto<Path<'p>>,

Check if path exists.

Returns Ok(true) if path exists, or Ok(false) if it does not exist.

Errors

An error will be returned if:

• path is not absolute.

This is not an exhaustive list of errors, see the crate documentation.

pub fn metadata<'p, P>(&self, path: P) -> Result<Metadata, Ext4Error>

where P: TryInto<Path<'p>>,

Get Metadata for path.

Errors

An error will be returned if:

• path is not absolute.
• path does not exist.

This is not an exhaustive list of errors, see the crate documentation.

pub fn symlink_metadata<'p, P>(&self, path: P) -> Result<Metadata, Ext4Error>

where P: TryInto<Path<'p>>,

Get Metadata for path.

If the final component of path is a symlink, information about the symlink itself will be returned, not the symlink’s targets. Any other symlink components of path are resolved as normal.

Errors

An error will be returned if:

• path is not absolute.
• path does not exist.

This is not an exhaustive list of errors, see the crate documentation.

Trait Implementations

impl Clone for Ext4

fn clone(&self) -> Ext4

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Ext4

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

Formats the value using the given formatter.