Struct clgit::Name

pub struct Name(_);

A git file or tree name (e.g. ".gitignore") - typically UTF8, but not guaranteed.

Implementations

impl Name

pub fn from(v: impl Into<Self>) -> Self

Construct a Name from a String, &str, Vec<u8>, or &[u8]

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

Get this Name as a UTF8 string. Use as_str_lossy if you don't care about preserving non-UTF8 byte sequences.

pub fn as_str_lossy(&self) -> &str

Get this Name as a UTF8 string. If the original name wasn't UTF8, this won't be exactly the same as the original.

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

Get this Name as a series of bytes. If the original name was an OsString or PathBuf, this might fail.

Trait Implementations

impl Borrow<str> for Name

fn borrow(&self) -> &str

Immutably borrows from an owned value.

impl Clone for Name

fn clone(&self) -> Name

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Name

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

Formats the value using the given formatter.

impl Default for Name

fn default() -> Self

Returns the "default value" for a type.

impl Eq for Name

impl<'_> From<&'_ [u8]> for Name

fn from(v: &[u8]) -> Self

Performs the conversion.

impl<'_> From<&'_ str> for Name

fn from(v: &str) -> Self

Performs the conversion.

impl From<String> for Name

fn from(v: String) -> Self

Performs the conversion.

impl From<Vec<u8>> for Name

fn from(v: Vec<u8>) -> Self

Performs the conversion.

impl Hash for Name

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, 

Feeds a slice of this type into the given Hasher.

impl Ord for Name

fn cmp(&self, other: &Name) -> Ordering

This method returns an Ordering between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl<'_> PartialEq<&'_ [u8]> for Name

fn eq(&self, other: &&[u8]) -> 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<'_> PartialEq<&'_ Name> for str

fn eq(&self, other: &&Name) -> 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<'_> PartialEq<&'_ Name> for [u8]

fn eq(&self, other: &&Name) -> 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<'_> PartialEq<&'_ str> for Name

fn eq(&self, other: &&str) -> 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 PartialEq<[u8]> for Name

fn eq(&self, other: &[u8]) -> 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 PartialEq<Name> for Name

fn eq(&self, other: &Name) -> bool

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

fn ne(&self, other: &Name) -> bool

This method tests for !=.

impl PartialEq<Name> for str

fn eq(&self, other: &Name) -> 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 PartialEq<Name> for [u8]

fn eq(&self, other: &Name) -> 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 PartialEq<str> for Name

fn eq(&self, other: &str) -> 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 PartialOrd<Name> for Name

fn partial_cmp(&self, other: &Name) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Name) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Name) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Name) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Name) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralEq for Name

impl StructuralPartialEq for Name