Struct File

pub struct File { /* private fields */ }

Represents a file, which may be embedded or dynamic.

Implementations

impl File

pub fn reader(&self) -> Result<FileReader, Error>

Returns a reader for the file’s contents. May return an error if the file cannot be opened.

pub fn path(&self) -> &Path

Returns the relative path of the file.

pub fn is_embedded(&self) -> bool

Returns true if the file is embedded in the binary.

pub fn absolute_path(&self) -> Option<&Path>

Returns the absolute path if the file is dynamic, or None if embedded.

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

Returns the file extension, if any.

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

Hashes a file by its relative path.

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

Files are equal if their relative paths are equal.

fn eq(&self, other: &Self) -> 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