pub enum Value {
Show 22 variants
Dead,
Unit,
Bool(bool),
Int(Integer),
Float(f64),
Complex(Complex),
Prob(f64),
Str(Arc<str>),
List(Arc<Hashed<Vec<Value>>>),
Map(Arc<Hashed<BTreeMap<Value, Value>>>),
Bag(Arc<Hashed<Multiset>>),
Range(Integer, Integer),
Record(Arc<Hashed<Record>>),
Enum(Arc<EnumValue>),
Dist(Arc<Dist>),
Continuous(Arc<Family>),
Closure(Arc<Closure>),
Builtin(Builtin),
Date(i32),
Delayed(Arc<Delayed>),
Analytic(Arc<Analytic>),
Event(Arc<Event>),
}Variants§
Dead
A slot with no value: not assigned yet, or cleared because it’s dead.
Unit
Bool(bool)
A fact: true or false in a world.
Int(Integer)
Float(f64)
Complex(Complex)
Prob(f64)
A probability: a number from 0 to 1. It’s a parameter, not an event.
Str(Arc<str>)
List(Arc<Hashed<Vec<Value>>>)
Map(Arc<Hashed<BTreeMap<Value, Value>>>)
Bag(Arc<Hashed<Multiset>>)
A multiset: value → count.
Range(Integer, Integer)
Integers from .0 to .1, both included.
Record(Arc<Hashed<Record>>)
Enum(Arc<EnumValue>)
Dist(Arc<Dist>)
Continuous(Arc<Family>)
A continuous distribution (docs/semantics.md, section 13).
Closure(Arc<Closure>)
Builtin(Builtin)
Date(i32)
Days since 1970-01-01.
Delayed(Arc<Delayed>)
A variable’s value that isn’t drawn yet, internal to the engine
(docs/semantics.md, section 14). The engine draws it before any
value read; a direct typeof inspection only needs its outcome type.
Analytic(Arc<Analytic>)
A scalar outcome retained analytically during enumeration.
Event(Arc<Event>)
A boolean predicate of that same outcome, retaining its identity.
Implementations§
Source§impl Value
impl Value
pub fn str(s: &str) -> Value
pub fn list(items: Vec<Value>) -> Value
pub fn map(entries: BTreeMap<Value, Value>) -> Value
pub fn bag(counts: BTreeMap<Value, u64>) -> Value
pub fn multiset(contents: Multiset) -> Value
pub fn record(record: Record) -> Value
A copy that shares no collection or string with the original. Values are shared through reference counts: threads that all read the same data would compete for those, so each sampling thread takes a copy.
Sourcepub fn is_uncertain(&self) -> bool
pub fn is_uncertain(&self) -> bool
Any distribution, including continuous ones: not a settled value.
Sourcepub fn as_complex(&self) -> Option<Complex>
pub fn as_complex(&self) -> Option<Complex>
Promote real numeric data to a complex scalar, without accepting facts or converting complex data back into real probabilities.
Trait Implementations§
impl Eq for Value
Source§impl Ord for Value
impl Ord for Value
1.21.0 (const: unstable) · Source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere
Self: Sized,
1.21.0 (const: unstable) · Source§fn min(self, other: Self) -> Selfwhere
Self: Sized,
fn min(self, other: Self) -> Selfwhere
Self: Sized,
Auto Trait Implementations§
impl Freeze for Value
impl RefUnwindSafe for Value
impl Send for Value
impl Sync for Value
impl Unpin for Value
impl UnsafeUnpin for Value
impl UnwindSafe for Value
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<Q, K> Comparable<K> for Q
impl<Q, K> Comparable<K> for Q
Source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
Source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
Source§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key and return true if they are equal.Source§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);