Enum git_checks::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.

Methods

impl FileName

pub fn new<P>(path: P) -> Self where     P: AsRef<str>,

Parse a path from Git.

Panics

Panics if non-ASCII paths are not formatted according to Git's ls-files formatting using core.quotePath=true.

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 Eq for FileName

impl PartialEq<FileName> for FileName

fn eq(&self, rhs: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl AsRef<str> for FileName

fn as_ref(&self) -> &str

Performs the conversion.

impl AsRef<[u8]> for FileName

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

Performs the conversion.

impl AsRef<OsStr> for FileName

fn as_ref(&self) -> &OsStr

Performs the conversion.

impl AsRef<Path> for FileName

fn as_ref(&self) -> &Path

Performs the conversion.

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.