Struct Specified 

pub struct Specified<T> { /* private fields */ }

Specified value.

This data type is a thin wrapper around a value of type T, augmenting the value with its computed Specificity, so it can be efficiently ordered.

Note that specifities are ordered from lowest to highest, with the least specific value being the first in order. It would be natural to reverse this order, but this would lead to more complex implementations for when a specified value is wrapped in an Option.

Implementations

impl<T> Specified<T>

pub fn into_inner(self) -> T

Returns the inner value, consuming the specified value.

Examples

use zrx_id::selector;
use zrx_id::specificity::Specified;

// Create selector
let selector = selector!(location = "**/*.md")?;

// Create specified value from selector
let value = Specified::from(selector.clone());
assert_eq!(value.into_inner(), selector);

impl<T> Specified<T>

pub fn specificity(&self) -> Specificity

Returns the specificity.

Trait Implementations

impl<T: Clone> Clone for Specified<T>

fn clone(&self) -> Specified<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Specified<T>

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

Formats the value using the given formatter.

impl<T: Default> Default for Specified<T>

fn default() -> Specified<T>

Returns the “default value” for a type.

impl<T> Deref for Specified<T>

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

Dereferences to the inner value.

type Target = T

The resulting type after dereferencing.

impl<T> From<T> for Specified<T>

where T: ToSpecificity,

fn from(inner: T) -> Self

Creates a specified value from a value.

Examples

use zrx_id::selector;
use zrx_id::specificity::Specified;

// Create selector
let selector = selector!(location = "**/*.md")?;

// Create specified value from selector
let value = Specified::from(selector);
assert_eq!(value.specificity(), (0, 1, 1, 3).into());

impl<T> Ord for Specified<T>

where T: Eq,

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

Orders two values by specificity.

Examples

use zrx_id::selector;
use zrx_id::specificity::Specified;

// Create and compare selectors by specificity
let a = Specified::from(selector!(location = "**/*.md")?);
let b = Specified::from(selector!(location = "*.md")?);
assert!(a < b);

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<T> PartialEq for Specified<T>

where T: PartialEq,

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

Compares two specified values for equality.

Examples

use zrx_id::selector;
use zrx_id::specificity::Specified;

// Create and compare selectors
let a = Specified::from(selector!(location = "*.md")?);
let b = Specified::from(selector!(location = "*.md")?);
assert_eq!(a, b);

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<T> PartialOrd for Specified<T>

where T: Eq,

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

Orders two values by specificity.

Examples

use zrx_id::selector;
use zrx_id::specificity::Specified;

// Create and compare selectors by specificity
let a = Specified::from(selector!(location = "**/*.md")?);
let b = Specified::from(selector!(location = "*.md")?);
assert!(a < b);

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<T> Eq for Specified<T>

where T: Eq,