Struct File

pub struct File<'a> {
    pub path: Cow<'a, str>,
    pub meta: Option<FileMetadata<'a>>,
}

The file path and any additional info of either the old file or the new file

Fields

path: Cow<'a, str>

The parsed path or file name of the file

Avoids allocation if at all possible. Only allocates if the file path is a quoted string literal. String literals are necessary in some cases, for example if the file path has spaces in it. These literals can contain escaped characters which are initially seen as groups of two characters by the parser (e.g. ‘\’ + ‘n’). A newly allocated string is used to unescape those characters (e.g. “\n” -> ‘\n’).

Note: While this string is typically a file path, this library makes no attempt to verify the format of that path. That means that this field can potentially be any string. You should verify it before doing anything that may be security-critical.

meta: Option<FileMetadata<'a>>

Any additional information provided with the file path

Trait Implementations

impl<'a> Clone for File<'a>

fn clone(&self) -> File<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for File<'a>

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

Formats the value using the given formatter.

impl<'a> Display for File<'a>

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

Formats the value using the given formatter.

impl<'a> PartialEq for File<'a>

fn eq(&self, other: &File<'a>) -> 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<'a> Eq for File<'a>

impl<'a> StructuralPartialEq for File<'a>