pub enum Value {
Show 23 variants
Int(i32),
Float(Fp),
String(String),
Bool(bool),
Unit,
Slice(Type, Vec<Rc<RefCell<Value>>>),
SlicePair(Type, SeqMap<Value, Rc<RefCell<Value>>>),
Option(Option<Rc<RefCell<Value>>>),
Vec(Type, Vec<Rc<RefCell<Value>>>),
Map(Type, SeqMap<Value, Rc<RefCell<Value>>>),
Tuple(Vec<Type>, Vec<Rc<RefCell<Value>>>),
Grid(Grid<Rc<RefCell<Value>>>),
Map2(Map2<Value, Value, Rc<RefCell<Value>>>),
Sparse(Type, SparseValueMap),
NamedStruct(NamedStructType, Vec<Rc<RefCell<Value>>>),
AnonymousStruct(AnonymousStructType, Vec<Rc<RefCell<Value>>>),
EnumVariantSimple(EnumType, EnumVariantSimpleType),
EnumVariantTuple(EnumType, EnumVariantTupleType, Vec<Rc<RefCell<Value>>>),
EnumVariantStruct(EnumType, EnumVariantStructType, Vec<Rc<RefCell<Value>>>),
InternalFunction(Rc<InternalFunctionDefinition>),
ExternalFunction(Rc<ExternalFunctionDefinition>),
RustValue(ExternalType, Rc<RefCell<Box<dyn RustType>>>),
Lambda(Vec<Rc<Variable>>, Box<Expression>),
}
Variants§
Int(i32)
Float(Fp)
String(String)
Bool(bool)
Unit
Slice(Type, Vec<Rc<RefCell<Value>>>)
SlicePair(Type, SeqMap<Value, Rc<RefCell<Value>>>)
Option(Option<Rc<RefCell<Value>>>)
Vec(Type, Vec<Rc<RefCell<Value>>>)
Map(Type, SeqMap<Value, Rc<RefCell<Value>>>)
Tuple(Vec<Type>, Vec<Rc<RefCell<Value>>>)
Grid(Grid<Rc<RefCell<Value>>>)
Map2(Map2<Value, Value, Rc<RefCell<Value>>>)
Sparse(Type, SparseValueMap)
NamedStruct(NamedStructType, Vec<Rc<RefCell<Value>>>)
AnonymousStruct(AnonymousStructType, Vec<Rc<RefCell<Value>>>)
EnumVariantSimple(EnumType, EnumVariantSimpleType)
EnumVariantTuple(EnumType, EnumVariantTupleType, Vec<Rc<RefCell<Value>>>)
EnumVariantStruct(EnumType, EnumVariantStructType, Vec<Rc<RefCell<Value>>>)
InternalFunction(Rc<InternalFunctionDefinition>)
ExternalFunction(Rc<ExternalFunctionDefinition>)
RustValue(ExternalType, Rc<RefCell<Box<dyn RustType>>>)
Lambda(Vec<Rc<Variable>>, Box<Expression>)
Implementations§
Source§impl Value
impl Value
Sourcepub fn quick_serialize(&self, octets: &mut [u8], depth: usize) -> usize
pub fn quick_serialize(&self, octets: &mut [u8], depth: usize) -> usize
Serialize as quickly as possible Endian format is undefined. It is only used for serializing during a running application
Source§impl Value
impl Value
Sourcepub fn into_iter_pairs(
self,
) -> Result<Box<dyn Iterator<Item = (Value, Value)>>, ValueError>
pub fn into_iter_pairs( self, ) -> Result<Box<dyn Iterator<Item = (Value, Value)>>, ValueError>
pub fn convert_to_string_if_needed(&self) -> String
Sourcepub fn expect_string(&self) -> Result<String, ValueError>
pub fn expect_string(&self) -> Result<String, ValueError>
§Errors
pub fn expect_struct( &self, ) -> Result<(NamedStructType, &Vec<Rc<RefCell<Value>>>), ValueError>
pub fn expect_anon_struct( &self, ) -> Result<(AnonymousStructType, &Vec<Rc<RefCell<Value>>>), ValueError>
pub fn expect_array( &self, ) -> Result<(Type, &Vec<Rc<RefCell<Value>>>), ValueError>
pub fn expect_map( &self, ) -> Result<(Type, &SeqMap<Value, Rc<RefCell<Value>>>), ValueError>
pub fn expect_map_mut( &mut self, ) -> Result<(Type, &mut SeqMap<Value, Rc<RefCell<Value>>>), ValueError>
Sourcepub fn expect_int(&self) -> Result<i32, ValueError>
pub fn expect_int(&self) -> Result<i32, ValueError>
§Errors
Sourcepub fn expect_bool(&self) -> Result<bool, ValueError>
pub fn expect_bool(&self) -> Result<bool, ValueError>
§Errors
Sourcepub fn expect_slice(
&self,
) -> Result<(Type, Vec<Rc<RefCell<Value>>>), ValueError>
pub fn expect_slice( &self, ) -> Result<(Type, Vec<Rc<RefCell<Value>>>), ValueError>
§Errors
Sourcepub fn expect_slice_pair(
&self,
) -> Result<(Type, &SeqMap<Value, Rc<RefCell<Value>>>), ValueError>
pub fn expect_slice_pair( &self, ) -> Result<(Type, &SeqMap<Value, Rc<RefCell<Value>>>), ValueError>
§Errors
Sourcepub fn expect_float(&self) -> Result<Fp, ValueError>
pub fn expect_float(&self) -> Result<Fp, ValueError>
§Errors
Sourcepub fn downcast_rust<T>(&self) -> Option<Rc<RefCell<Box<T>>>>where
T: RustType + 'static,
pub fn downcast_rust<T>(&self) -> Option<Rc<RefCell<Box<T>>>>where
T: RustType + 'static,
§Errors
pub fn new_rust_value<T>(rust_type_ref: ExternalType, value: T) -> Value
Trait Implementations§
Source§impl TryFrom<ValueWithSignal> for Value
impl TryFrom<ValueWithSignal> for Value
impl Eq for Value
Auto Trait Implementations§
impl Freeze for Value
impl !RefUnwindSafe for Value
impl !Send for Value
impl !Sync for Value
impl Unpin 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<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
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>
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);