Struct File

pub struct File { /* private fields */ }

Represents a file, which may be embedded or from the filesystem. Provides methods to access file contents and metadata.

Implementations

impl File

pub fn file_name(&self) -> Option<&str>

Returns the file name as a string slice, if available.

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

Returns the file extension as a string slice, if available.

pub fn absolute_path(&self) -> &Path

Returns the absolute path of this file.

pub fn is_embedded(&self) -> bool

Returns true if this file is embedded in the binary.

pub fn path(&self) -> &Path

Returns the relative path of this file.

pub fn read_bytes(&self) -> Result<Vec<u8>>

Reads the file contents as bytes.

pub fn read_str(&self) -> Result<String>

Reads the file contents as a UTF-8 string. Returns an error if the contents are not valid UTF-8.

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

Returns the metadata for this file, such as modification time and size.

Trait Implementations

impl Clone for File

fn clone(&self) -> File

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for File

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

Formats the value using the given formatter.

impl Hash for File

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for File

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

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for File

impl StructuralPartialEq for File