Struct lattices::WithTop

pub struct WithTop<Inner>(/* private fields */);

Adds a new “top” value to the nested lattice type.

Given an existing lattice, wrap it into a new lattice with a new top element. The new top element compares as less than all the values of the wrapped lattice. This can be used for giving a sensible default/bottom element to lattices that don’t necessarily have one.

The implementation wraps an Option, with None representing the top element.

Implementations

impl<Inner> WithTop<Inner>

pub fn new(val: Option<Inner>) -> Self

Create a new WithTop lattice instance from a value.

pub fn new_from(val: impl Into<Option<Inner>>) -> Self

Create a new WithTop lattice instance from a value using Into.

pub fn as_reveal_ref(&self) -> Option<&Inner>

Reveal the inner value as a shared reference.

pub fn as_reveal_mut(&mut self) -> Option<&mut Inner>

Reveal the inner value as an exclusive reference.

pub fn into_reveal(self) -> Option<Inner>

Gets the inner by value, consuming self.

Trait Implementations

impl<Inner> Atomize for WithTop<Inner>

where Inner: Atomize + LatticeFrom<<Inner as Atomize>::Atom>,

type Atom = WithTop<<Inner as Atomize>::Atom>

The type of atoms for this lattice.

type AtomIter = Box<dyn Iterator<Item = <WithTop<Inner> as Atomize>::Atom>>

The iter type iterating the antichain atoms.

fn atomize(self) -> Self::AtomIter

Atomize self: convert into an iter of atoms.

impl<Inner: Clone> Clone for WithTop<Inner>

fn clone(&self) -> WithTop<Inner>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Inner: Debug> Debug for WithTop<Inner>

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

Formats the value using the given formatter.

impl<Inner> DeepReveal for WithTop<Inner>

where Inner: DeepReveal,

type Revealed = Option<<Inner as DeepReveal>::Revealed>

The underlying type when revealed.

fn deep_reveal(self) -> Self::Revealed

Reveals the underlying lattice types recursively.

impl<Inner> Default for WithTop<Inner>

where Inner: Default,

fn default() -> Self

Returns the “default value” for a type.

impl<'de, Inner> Deserialize<'de> for WithTop<Inner>

where Inner: Deserialize<'de>,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<Inner> IsBot for WithTop<Inner>

where Inner: IsBot,

fn is_bot(&self) -> bool

Returns if self is lattice bottom (⊥).

impl<Inner> IsTop for WithTop<Inner>

where Inner: IsTop,

fn is_top(&self) -> bool

Returns if self is lattice top (⊤).

impl<Inner, Other> LatticeFrom<WithTop<Other>> for WithTop<Inner>

where Inner: LatticeFrom<Other>,

fn lattice_from(other: WithTop<Other>) -> Self

Convert from the Other lattice into Self.

impl<Inner, Other> Merge<WithTop<Other>> for WithTop<Inner>

where Inner: Merge<Other> + LatticeFrom<Other>,

fn merge(&mut self, other: WithTop<Other>) -> bool

Merge other into the self lattice.

fn merge_owned(this: Self, delta: Other) -> Self

where Self: Sized,

Merge this and delta together, returning the new value.

impl<Inner, Other> PartialEq<WithTop<Other>> for WithTop<Inner>

where Inner: PartialEq<Other>,

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

where Inner: PartialOrd<Other>,

fn partial_cmp(&self, other: &WithTop<Other>) -> 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<Inner> Serialize for WithTop<Inner>

where Inner: Serialize,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<Inner: Copy> Copy for WithTop<Inner>

impl<Inner: Eq> Eq for WithTop<Inner>

impl<Inner, Other> LatticeOrd<WithTop<Other>> for WithTop<Inner>

where Self: PartialOrd<WithTop<Other>>,