Struct FileRef

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

A reference to a file. It wraps an Arc so it can be cloned thread-safely. A FileRef can be constructed either from a PathBuf or a (file://) Url, and provides (precomputed) access to these views using path() and url(), as well as rel() to get the relative path from CURRENT_DIR.

Implementations

impl FileRef

pub fn path(&self) -> &PathBuf

Convert this FileRef to a PathBuf, for use with OS file actions.

pub fn rel(&self) -> &str

Convert this FileRef to a relative path (as a &str).

pub fn ptr(&self) -> *const PathBuf

Get a pointer to this allocation, for use in hashing.

pub fn ptr_eq(&self, other: &FileRef) -> bool

Compare this with other for pointer equality.

pub fn has_extension(&self, ext: &str) -> bool

Returns true if this file has the provided extension.

Trait Implementations

impl Clone for FileRef

fn clone(&self) -> FileRef

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FileRef

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

Formats the value using the given formatter.

impl Display for FileRef

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

Formats the value using the given formatter.

impl From<PathBuf> for FileRef

fn from(path: PathBuf) -> FileRef

Converts to this type from the input type.

impl Hash for FileRef

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 FileRef

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 FileRef