Struct uefi::proto::media::file::Directory

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

A FileHandle that is also a directory.

Use File::into_type or Directory::new to create a Directory. In addition to supporting the normal File operations, Directory supports iterating over its contained files.

Implementations

impl Directory

pub unsafe fn new(handle: FileHandle) -> Self

Coverts a FileHandle into a Directory without checking the file type.

Safety

This function should only be called on files which ARE directories, doing otherwise is unsafe.

pub fn read_entry<'buf>( &mut self, buffer: &'buf mut [u8] ) -> Result<Option<&'buf mut FileInfo>, Option<usize>>

Read the next directory entry.

Try to read the next directory entry into buffer. If the buffer is too small, report the required buffer size as part of the error. If there are no more directory entries, return an empty optional.

The input buffer must be correctly aligned for a FileInfo. You can query the required alignment through the Align trait (<FileInfo as Align>::alignment()).

Arguments

• buffer The target buffer of the read operation

Errors

All errors come from calls to RegularFile::read.

pub fn read_entry_boxed(&mut self) -> Result<Option<Box<FileInfo>>>

Available on crate feature alloc only.

Wrapper around Self::read_entry that returns an owned copy of the data. It has the same implications and requirements. On failure, the payload of Err is `()´.

pub fn read_entry_boxed_in<A: Allocator>( &mut self, allocator: A ) -> Result<Option<Box<FileInfo>>>

Available on crate features unstable and alloc only.

Wrapper around Self::read_entry that returns an owned copy of the data. It has the same implications and requirements. On failure, the payload of Err is `()´.

It allows to use a custom allocator via the allocator_api feature.

pub fn reset_entry_readout(&mut self) -> Result

Start over the process of enumerating directory entries

Errors

All errors come from calls to RegularFile::set_position.

Trait Implementations

impl Debug for Directory

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

Formats the value using the given formatter.

impl File for Directory

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

Returns if the underlying file is a regular file. The result is an error if the underlying file was already closed or deleted.

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

Returns if the underlying file is a directory. The result is an error if the underlying file was already closed or deleted.

fn open( &mut self, filename: &CStr16, open_mode: FileMode, attributes: FileAttribute ) -> Result<FileHandle>

Try to open a file relative to this file.

fn close(self)

Close this file handle. Same as dropping this structure.

fn delete(self) -> Result

Closes and deletes this file

fn get_info<'buf, Info: FileProtocolInfo + ?Sized>( &mut self, buffer: &'buf mut [u8] ) -> Result<&'buf mut Info, Option<usize>>

Queries some information about a file

fn set_info<Info: FileProtocolInfo + ?Sized>(&mut self, info: &Info) -> Result

Sets some information about a file

fn flush(&mut self) -> Result

Flushes all modified data associated with the file handle to the device

fn get_boxed_info<Info: FileProtocolInfo + ?Sized + Debug>( &mut self ) -> Result<Box<Info>>

Available on crate feature alloc only.

Read the dynamically allocated info for a file.

fn get_boxed_info_in<Info: FileProtocolInfo + ?Sized + Debug, A: Allocator>( &mut self, allocator: A ) -> Result<Box<Info>>

Available on crate features unstable and alloc only.

Read the dynamically allocated info for a file.