Struct GoModulePath 

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

Validated Go module path metadata.

Implementations

impl GoModulePath

pub fn new(value: impl AsRef<str>) -> Result<Self, GoModuleError>

Creates a Go module path from non-empty text.

Errors

Returns GoModuleError when the path is empty, has whitespace, or has empty slash segments.

Examples found in repository

examples/basic_usage.rs (line 4)

fn main() -> Result<(), use_go_module::GoModuleError> {
    let path = GoModulePath::new("example.com/project")?;
    let version = GoModuleVersion::new("v1.2.3")?;
    let dependency = GoModuleDependency::new(path, version);

    assert_eq!(dependency.path().as_str(), "example.com/project");
    assert_eq!(dependency.version().as_str(), "v1.2.3");
    Ok(())
}

pub fn as_str(&self) -> &str

Returns the module path.

Examples found in repository

examples/basic_usage.rs (line 8)

fn main() -> Result<(), use_go_module::GoModuleError> {
    let path = GoModulePath::new("example.com/project")?;
    let version = GoModuleVersion::new("v1.2.3")?;
    let dependency = GoModuleDependency::new(path, version);

    assert_eq!(dependency.path().as_str(), "example.com/project");
    assert_eq!(dependency.version().as_str(), "v1.2.3");
    Ok(())
}

pub fn into_string(self) -> String

Consumes the path and returns the owned text.

Trait Implementations

impl AsRef<str> for GoModulePath

fn as_ref(&self) -> &str

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

impl Clone for GoModulePath

fn clone(&self) -> GoModulePath

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GoModulePath

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

Formats the value using the given formatter.

impl Display for GoModulePath

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

Formats the value using the given formatter.

impl FromStr for GoModulePath

type Err = GoModuleError

The associated error which can be returned from parsing.

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

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

impl Hash for GoModulePath

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 GoModulePath

fn cmp(&self, other: &GoModulePath) -> 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 GoModulePath

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

fn partial_cmp(&self, other: &GoModulePath) -> 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 TryFrom<&str> for GoModulePath

type Error = GoModuleError

The type returned in the event of a conversion error.

fn try_from(value: &str) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for GoModulePath

impl StructuralPartialEq for GoModulePath