Enum FileName

pub enum FileName {
    // some variants omitted
}

A representation of filenames as given by Git.

Git supports filenames with control characters and other non-Unicode byte sequence which are quoted when listed in certain Git command outputs. This enumeration smooths over these differences and offers accessors to the file name in different representations.

Generally, the as_ methods should be preferred to pattern matching on this enumeration.

Implementations

impl FileName

pub fn new<P>(path: P) -> Result<Self, FileNameError>

where P: AsRef<str>,

Parse a path from Git.

pub fn as_str(&self) -> &str

The file name as a str.

pub fn as_path(&self) -> &Path

The file name as a Path.

pub fn as_bytes(&self) -> &[u8]

The raw bytes of the file name.

Trait Implementations

impl AsRef<[u8]> for FileName

fn as_ref(&self) -> &[u8]

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<OsStr> for FileName

fn as_ref(&self) -> &OsStr

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<Path> for FileName

fn as_ref(&self) -> &Path

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<str> for FileName

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for FileName

fn clone(&self) -> FileName

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FileName

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

Formats the value using the given formatter.

impl Display for FileName

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

Formats the value using the given formatter.

impl PartialEq for FileName

fn eq(&self, rhs: &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 FileName