Struct Annotated 

pub struct Annotated<T, A> { /* private fields */ }

Annotated represents a value with an annotation. The value will be annotated by Annotate trait.

Examples

use semigroup::{op::Coalesce, Annotate, Annotated};

let annotated = Coalesce(Some(1)).annotated("first");

assert_eq!(annotated.value(), &Coalesce(Some(1)));
assert_eq!(annotated.annotation(), &"first");
assert_eq!(annotated, Annotated::new(Coalesce(Some(1)), "first"));

Implementations

impl<T: AnnotatedSemigroup<A>, A> Annotated<T, A>

pub fn lift_unit_annotated_op( (base, unit1): (T, A), (other, unit2): (T, A), ) -> T

impl<T, A> Annotated<T, A>

pub fn new(value: T, annotation: A) -> Self

pub fn into_parts(self) -> (T, A)

pub fn parts(&self) -> (&T, &A)

pub fn parts_mut(&mut self) -> (&mut T, &mut A)

pub fn into_value(self) -> T

pub fn value(&self) -> &T

pub fn value_mut(&mut self) -> &mut T

pub fn into_annotation(self) -> A

pub fn annotation(&self) -> &A

pub fn annotation_mut(&mut self) -> &mut A

pub fn map<U>(self, f: impl FnOnce(T) -> U) -> Annotated<U, A>

pub fn map_annotation<B>(self, f: impl FnOnce(A) -> B) -> Annotated<T, B>

pub fn map_parts<U, B>( self, fv: impl FnOnce(T) -> U, fa: impl FnOnce(A) -> B, ) -> Annotated<U, B>

pub fn as_ref(&self) -> Annotated<&T, &A>

pub fn as_ref_mut(&mut self) -> Annotated<&mut T, &mut A>

pub fn as_deref(&self) -> Annotated<&T::Target, &A>

where T: Deref,

pub fn as_deref_mut(&mut self) -> Annotated<&mut T::Target, &mut A>

where T: DerefMut,

impl<T, A> Annotated<&T, &A>

pub fn cloned(self) -> Annotated<T, A>

where T: Clone, A: Clone,

impl<T, A> Annotated<&mut T, &A>

pub fn cloned(self) -> Annotated<T, A>

where T: Clone, A: Clone,

impl<T, A> Annotated<&T, &mut A>

pub fn cloned(self) -> Annotated<T, A>

where T: Clone, A: Clone,

impl<T, A> Annotated<&mut T, &mut A>

pub fn cloned(self) -> Annotated<T, A>

where T: Clone, A: Clone,

impl<T, A> Annotated<&T, A>

pub fn value_cloned(self) -> Annotated<T, A>

where T: Clone,

impl<T, A> Annotated<&mut T, A>

pub fn value_cloned(self) -> Annotated<T, A>

where T: Clone,

impl<T, A> Annotated<T, &A>

pub fn annotation_cloned(self) -> Annotated<T, A>

where A: Clone,

impl<T, A> Annotated<T, &mut A>

pub fn annotation_cloned(self) -> Annotated<T, A>

where A: Clone,

Trait Implementations

impl<T: Clone, A: Clone> Clone for Annotated<T, A>

fn clone(&self) -> Annotated<T, A>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug, A: Debug> Debug for Annotated<T, A>

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

Formats the value using the given formatter.

impl<T: Default, A: Default> Default for Annotated<T, A>

fn default() -> Annotated<T, A>

Returns the “default value” for a type.

impl<T: Hash, A: Hash> Hash for Annotated<T, A>

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<T: Ord, A: Ord> Ord for Annotated<T, A>

fn cmp(&self, other: &Annotated<T, A>) -> 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<T: PartialEq, A: PartialEq> PartialEq for Annotated<T, A>

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

fn partial_cmp(&self, other: &Annotated<T, A>) -> 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<T: AnnotatedSemigroup<A>, A> Semigroup for Annotated<T, A>

fn op(base: Self, other: Self) -> Self

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

where Self: Sized,

impl<T: Copy, A: Copy> Copy for Annotated<T, A>

impl<T: Eq, A: Eq> Eq for Annotated<T, A>

impl<T, A> StructuralPartialEq for Annotated<T, A>