Struct SemverValue 

pub struct SemverValue {
    pub version: Version,
    pub prefix: String,
}

A semantic version value, optionally carrying a display prefix from loose parsing.

Equality and ordering compare only [version]; prefix is presentation metadata (e.g. "v" from v1.2.3 parsed with --loose). That means v1.0.0 and 1.0.0 compare equal, and command example result: values that use SemverValue only lock the version identity—not the display form. Prefer display() / to text when tests need to assert a preserved prefix.

Fields

version: Version

prefix: String

Original loose prefix such as "v", "v.", or "v:". Empty when none.

Implementations

impl SemverValue

pub fn new(version: Version) -> Self

pub fn with_prefix(version: Version, prefix: impl Into<String>) -> Self

pub fn display(&self) -> String

Display form including any loose prefix (e.g. v1.2.3).

pub fn parse(s: &str, loose: bool) -> Result<Self, Error>

Parse from a string. When loose is true, accepts prefixes like v, v., v:.

pub fn bump_major(&self) -> Self

pub fn bump_minor(&self) -> Self

pub fn bump_patch(&self) -> Self

pub fn bump_prerelease(&self, tag: &str) -> Result<Self, ShellError>

pub fn bump_release(&self) -> Self

pub fn set_build_metadata(&self, metadata: &str) -> Result<Self, ShellError>

pub fn try_from_value(value: &Value, loose: bool) -> Result<Self, ShellError>

Convert a pipeline value into a SemverValue.

When loose is true, string inputs may use prefixes like v1.2.3.

pub fn test_value(s: &str) -> Value

For use by tests and examples only.

Methods from Deref<Target = Version>

pub fn cmp_precedence(&self, other: &Version) -> Ordering

Compare the major, minor, patch, and pre-release value of two versions, disregarding build metadata. Versions that differ only in build metadata are considered equal. This comparison is what the SemVer spec refers to as “precedence”.

Example

use semver::Version;

let mut versions = [
    "1.20.0+c144a98".parse::<Version>().unwrap(),
    "1.20.0".parse().unwrap(),
    "1.0.0".parse().unwrap(),
    "1.0.0-alpha".parse().unwrap(),
    "1.20.0+bc17664".parse().unwrap(),
];

// This is a stable sort, so it preserves the relative order of equal
// elements. The three 1.20.0 versions differ only in build metadata so
// they are not reordered relative to one another.
versions.sort_by(Version::cmp_precedence);
assert_eq!(versions, [
    "1.0.0-alpha".parse().unwrap(),
    "1.0.0".parse().unwrap(),
    "1.20.0+c144a98".parse().unwrap(),
    "1.20.0".parse().unwrap(),
    "1.20.0+bc17664".parse().unwrap(),
]);

// Totally order the versions, including comparing the build metadata.
versions.sort();
assert_eq!(versions, [
    "1.0.0-alpha".parse().unwrap(),
    "1.0.0".parse().unwrap(),
    "1.20.0".parse().unwrap(),
    "1.20.0+bc17664".parse().unwrap(),
    "1.20.0+c144a98".parse().unwrap(),
]);

Trait Implementations

impl Clone for SemverValue

fn clone(&self) -> SemverValue

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl CustomValue for SemverValue

fn clone_value(&self, span: Span) -> Value

Custom Clone implementation

fn type_name(&self) -> String

The friendly type name to show for the custom value, e.g. in describe and in error messages. This does not have to be the same as the name of the struct or enum, but conventionally often is.

fn to_base_value(&self, span: Span) -> Result<Value, ShellError>

Converts the custom value to a base nushell value.

fn as_any(&self) -> &dyn Any

Any representation used to downcast object to its original type

fn as_mut_any(&mut self) -> &mut dyn Any

Any representation used to downcast object to its original type (mutable reference)

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

ordering with other value (see std::cmp::PartialOrd)

fn follow_path_string( &self, self_span: Span, column_name: String, path_span: Span, _optional: bool, casing: Casing, ) -> Result<Value, ShellError>

Follow cell path by string key (e.g. columns).

fn operation( &self, lhs_span: Span, operator: Operator, op: Span, right: &Value, ) -> Result<Value, ShellError>

Definition of an operation between the object that implements the trait and another Value.

fn follow_path_int( &self, self_span: Span, index: usize, path_span: Span, optional: bool, ) -> Result<Value, ShellError>

Follow cell path by numeric index (e.g. rows).

fn update_data_at_cell_path( &self, cell_path: &[PathMember], new_val: Value, action: &CellPathMutation, head: Span, ) -> Result<Value, ShellError>

Update a value at the given cell path, returning a new Value.

fn save( &self, path: Spanned<&Path>, value_span: Span, save_span: Span, ) -> Result<(), ShellError>

Save custom value to disk.

fn notify_plugin_on_drop(&self) -> bool

For custom values in plugins: return true here if you would like to be notified when all copies of this custom value are dropped in the engine.

fn memory_size(&self) -> usize

Returns an estimate of the memory size used by this CustomValue in bytes

fn is_iterable(&self) -> bool

👎Deprecated since 0.111.1:

will be replaced by a new custom-value iterator system next release; avoid new uses unless you need current behavior

Returns true if this custom value should be iterable (like a list) when used with commands like each, where, etc.

impl Debug for SemverValue

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

Formats the value using the given formatter.

impl Deref for SemverValue

type Target = Version

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'de> Deserialize<'de> for SemverValue

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for SemverValue

impl Ord for SemverValue

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

Compares only the underlying SemVer version; prefix is ignored.

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for SemverValue

fn partial_cmp(&self, other: &Self) -> 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 SemverValue

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<'a> TryFrom<&'a Value> for SemverValue

type Error = ShellError

The type returned in the event of a conversion error.

fn try_from(value: &'a Value) -> Result<Self, Self::Error>

Performs the conversion.