pub enum VmValue {
Show 25 variants
Int(i64),
Float(f64),
String(Rc<str>),
Bytes(Rc<Vec<u8>>),
Bool(bool),
Nil,
List(Rc<Vec<VmValue>>),
Dict(Rc<BTreeMap<String, VmValue>>),
Closure(Rc<VmClosure>),
BuiltinRef(Rc<str>),
BuiltinRefId {
id: BuiltinId,
name: Rc<str>,
},
Duration(i64),
EnumVariant {
enum_name: Rc<str>,
variant: Rc<str>,
fields: Rc<Vec<VmValue>>,
},
StructInstance {
layout: Rc<StructLayout>,
fields: Rc<Vec<Option<VmValue>>>,
},
TaskHandle(String),
Channel(VmChannelHandle),
Atomic(VmAtomicHandle),
Rng(VmRngHandle),
SyncPermit(VmSyncPermitHandle),
McpClient(VmMcpClientHandle),
Set(Rc<Vec<VmValue>>),
Generator(VmGenerator),
Range(VmRange),
Iter(Rc<RefCell<VmIter>>),
Pair(Rc<(VmValue, VmValue)>),
}Expand description
VM runtime value.
Rare compound payloads use shared pointers so cloning or moving common values does not pay for the largest enum alternatives. Unsafe layouts such as NaN boxing or tagged pointers are deliberately deferred until Harn has a stronger object/heap story.
Variants§
Int(i64)
Float(f64)
String(Rc<str>)
Bytes(Rc<Vec<u8>>)
Bool(bool)
Nil
List(Rc<Vec<VmValue>>)
Dict(Rc<BTreeMap<String, VmValue>>)
Closure(Rc<VmClosure>)
BuiltinRef(Rc<str>)
Reference to a registered builtin function, used when a builtin name is
referenced as a value (e.g. snake_dict.rekey(snake_to_camel)). The
contained string is the builtin’s registered name.
BuiltinRefId
Compact builtin reference for callback positions. Carries the name for policy, diagnostics, and fallback if the ID cannot be used.
Duration(i64)
EnumVariant
StructInstance
TaskHandle(String)
Channel(VmChannelHandle)
Atomic(VmAtomicHandle)
Rng(VmRngHandle)
SyncPermit(VmSyncPermitHandle)
McpClient(VmMcpClientHandle)
Set(Rc<Vec<VmValue>>)
Generator(VmGenerator)
Range(VmRange)
Iter(Rc<RefCell<VmIter>>)
Lazy iterator handle. Single-pass, fused. See crate::vm::iter::VmIter.
Pair(Rc<(VmValue, VmValue)>)
Two-element pair value. Produced by pair(a, b), yielded by the
Dict iterator source, and (later) by zip / enumerate combinators.
Accessed via .first / .second, and destructurable in
for (a, b) in ... loops.
Implementations§
Source§impl VmValue
impl VmValue
pub fn enum_variant( enum_name: impl Into<Rc<str>>, variant: impl Into<Rc<str>>, fields: Vec<VmValue>, ) -> Self
pub fn struct_instance( struct_name: impl Into<Rc<str>>, fields: BTreeMap<String, VmValue>, ) -> Self
pub fn is_truthy(&self) -> bool
pub fn type_name(&self) -> &'static str
pub fn struct_name(&self) -> Option<&str>
pub fn struct_field(&self, field_name: &str) -> Option<&VmValue>
pub fn struct_fields_map(&self) -> Option<BTreeMap<String, VmValue>>
pub fn struct_instance_from_map( struct_name: impl Into<String>, fields: BTreeMap<String, VmValue>, ) -> Self
pub fn struct_instance_with_layout( struct_name: impl Into<String>, field_names: Vec<String>, field_values: BTreeMap<String, VmValue>, ) -> Self
pub fn struct_instance_with_property( &self, field_name: String, value: VmValue, ) -> Option<Self>
pub fn display(&self) -> String
Sourcepub fn write_display(&self, out: &mut String)
pub fn write_display(&self, out: &mut String)
Writes the display representation directly into out,
avoiding intermediate Vec
Sourcepub fn as_dict(&self) -> Option<&BTreeMap<String, VmValue>>
pub fn as_dict(&self) -> Option<&BTreeMap<String, VmValue>>
Get the value as a BTreeMap reference, if it’s a Dict.
pub fn as_int(&self) -> Option<i64>
pub fn as_bytes(&self) -> Option<&[u8]>
Trait Implementations§
Auto Trait Implementations§
impl Freeze for VmValue
impl !RefUnwindSafe for VmValue
impl !Send for VmValue
impl !Sync for VmValue
impl Unpin for VmValue
impl UnsafeUnpin for VmValue
impl !UnwindSafe for VmValue
Blanket Implementations§
Source§impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
Source§impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
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> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§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);