Struct GitModulePath 

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

A validated, canonical sub-path within a Git-backed dependency.

Represents the path field on a Git dependency source—the relative directory within the repository that contains the module’s module.json. Wraps RelativePath and additionally rejects "." and empty strings, both of which are semantically equivalent to “no sub-path” (i.e., the module sits at the repository root).

Implementations

impl GitModulePath

pub fn as_str(&self) -> &str

Returns the path as a /-separated string slice.

pub fn as_path(&self) -> &Path

Returns the path as a Path.

pub fn into_relative_path(self) -> RelativePath

Consumes the GitModulePath and returns the underlying RelativePath.

Trait Implementations

impl AsRef<Path> for GitModulePath

fn as_ref(&self) -> &Path

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

impl AsRef<str> for GitModulePath

fn as_ref(&self) -> &str

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

impl Clone for GitModulePath

fn clone(&self) -> GitModulePath

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GitModulePath

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for GitModulePath

where Self: FromStr, <Self as FromStr>::Err: Display,

fn deserialize<__D>(deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for GitModulePath

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

Formats the value using the given formatter.

impl Eq for GitModulePath

impl From<GitModulePath> for String

fn from(path: GitModulePath) -> Self

Converts to this type from the input type.

impl From<GitModulePath> for PathBuf

fn from(path: GitModulePath) -> Self

Converts to this type from the input type.

impl FromStr for GitModulePath

type Err = GitModulePathError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for GitModulePath

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 Ord for GitModulePath

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

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for GitModulePath

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for GitModulePath

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Serialize for GitModulePath

where Self: Display,

fn serialize<__S>(&self, serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for GitModulePath

impl TryFrom<&Path> for GitModulePath

type Error = GitModulePathError

The type returned in the event of a conversion error.

fn try_from(path: &Path) -> Result<Self, Self::Error>

Performs the conversion.