Struct uefi::fs::FileSystem

pub struct FileSystem<'a>(_);

Available on crate feature alloc only.

High-level file-system abstraction for UEFI volumes with an API that is close to std::fs. It acts as convenient accessor around the SimpleFileSystemProtocol.

Implementations

impl<'a> FileSystem<'a>

pub fn new(proto: ScopedProtocol<'a, SimpleFileSystemProtocol>) -> Self

Constructor.

pub fn try_exists(&mut self, path: impl AsRef<Path>) -> FileSystemResult<()>

Tests if the underlying file exists. If this returns Ok, the file exists.

pub fn copy( &mut self, src_path: impl AsRef<Path>, dest_path: impl AsRef<Path> ) -> FileSystemResult<()>

Copies the contents of one file to another. Creates the destination file if it doesn’t exist and overwrites any content, if it exists.

pub fn create_dir(&mut self, path: impl AsRef<Path>) -> FileSystemResult<()>

Creates a new, empty directory at the provided path

pub fn create_dir_all(&mut self, path: impl AsRef<Path>) -> FileSystemResult<()>

Recursively create a directory and all of its parent components if they are missing.

pub fn metadata( &mut self, path: impl AsRef<Path> ) -> FileSystemResult<Box<UefiFileInfo>>

Given a path, query the file system to get information about a file, directory, etc. Returns UefiFileInfo.

pub fn read(&mut self, path: impl AsRef<Path>) -> FileSystemResult<Vec<u8>>

Read the entire contents of a file into a bytes vector.

pub fn read_dir( &mut self, path: impl AsRef<Path> ) -> FileSystemResult<UefiDirectoryIter>

Returns an iterator over the entries within a directory.

pub fn read_to_string( &mut self, path: impl AsRef<Path> ) -> FileSystemResult<String>

Read the entire contents of a file into a Rust string.

pub fn remove_dir(&mut self, path: impl AsRef<Path>) -> FileSystemResult<()>

Removes an empty directory.

pub fn remove_dir_all(&mut self, path: impl AsRef<Path>) -> FileSystemResult<()>

Removes a directory at this path, after removing all its contents. Use carefully!

pub fn remove_file(&mut self, path: impl AsRef<Path>) -> FileSystemResult<()>

Removes a file from the filesystem.

pub fn rename( &mut self, src_path: impl AsRef<Path>, dest_path: impl AsRef<Path> ) -> FileSystemResult<()>

Rename a file or directory to a new name, replacing the original file if it already exists.

pub fn write( &mut self, path: impl AsRef<Path>, content: impl AsRef<[u8]> ) -> FileSystemResult<()>

Write a slice as the entire contents of a file. This function will create a file if it does not exist, and will entirely replace its contents if it does.

Trait Implementations

impl<'a> Debug for FileSystem<'a>

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

Formats the value using the given formatter.