Enum Value 

pub enum Value {
    Null,
    Bool(bool),
    Int(i64),
    Float(f64),
    Str(String),
    List(Vec<Value>),
    Map(Vec<(String, Value)>),
}

A dynamically typed value: null, bool, int, float, string, list or an ordered string-keyed map. See the module docs for an example.

Variants

Null

Bool(bool)

Int(i64)

Float(f64)

Str(String)

List(Vec<Value>)

Map(Vec<(String, Value)>)

Implementations

impl Value

pub fn owns_buffers(&self) -> bool

Whether the value holds a heap buffer — a string, a list or a map — that Clone::clone_from can write another like it into.

pub fn str(s: impl Into<String>) -> Value

A string value.

pub fn map(entries: impl IntoIterator<Item = (&'static str, Value)>) -> Value

A map from (key, value) pairs, in the order given.

pub fn get(&self, key: &str) -> Option<&Value>

The entry under key of a map; None for a missing key or a value that is not a map.

pub fn as_str(&self) -> Option<&str>

pub fn as_int(&self) -> Option<i64>

The number as an integer; a float is truncated.

pub fn as_list(&self) -> Option<&[Value]>

pub fn as_float(&self) -> Option<f64>

The number as a float; an int converts.

pub fn type_name(&self) -> &'static str

What kind of value this is, for an error message.

pub fn as_bool(&self) -> Option<bool>

pub fn get_str(&self, key: &str) -> Option<&str>

get(key) then as_str: a map entry read as a string.

pub fn get_int(&self, key: &str) -> Option<i64>

get(key) then as_int.

pub fn get_float(&self, key: &str) -> Option<f64>

get(key) then as_float.

pub fn get_f32(&self, key: &str) -> Option<f32>

get(key) then as_float, as the f32 geometry is in — a drag’s x, a scroll’s dy.

pub fn get_bool(&self, key: &str) -> Option<bool>

get(key) then as_bool.

impl Value

pub fn float(v: f32) -> Value

A float, as a readback spells one.

pub fn opt<T>(v: Option<T>, f: impl FnOnce(T) -> Value) -> Value

An Option as the value or Null: a readback keeps every key, so a reader destructures a stable shape.

pub fn opt_str(s: &Option<String>) -> Value

pub fn opt_float(v: Option<f32>) -> Value

pub fn opt_usize(v: Option<usize>) -> Value

pub fn opt_bool(v: Option<bool>) -> Value

pub fn list(items: impl IntoIterator<Item = Value>) -> Value

pub fn floats(items: &[f32]) -> Value

Trait Implementations

impl Clone for Value

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

Into the buffers self already has where the two are the same shape — a string into a string, a map into a map, entry by entry — so a value written over with another like it allocates nothing: what the core does with every click message every frame (backlog F281). The result is source.clone() either way.

fn clone(&self) -> Self

Returns a duplicate of the value.

impl Debug for Value

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

Formats the value using the given formatter.

impl Default for Value

fn default() -> Self

Returns the “default value” for a type.

impl From<&Value> for Value

A copy, so ev.message::<Value>() and ev.split::<Value>() read an event’s message untyped.

fn from(v: &Value) -> Self

Converts to this type from the input type.

impl From<&str> for Value

fn from(s: &str) -> Self

Converts to this type from the input type.

impl From<String> for Value

fn from(s: String) -> Self

Converts to this type from the input type.

impl From<bool> for Value

fn from(v: bool) -> Self

Converts to this type from the input type.

impl From<f32> for Value

fn from(v: f32) -> Self

Converts to this type from the input type.

impl From<f64> for Value

fn from(v: f64) -> Self

Converts to this type from the input type.

impl From<i32> for Value

fn from(v: i32) -> Self

Converts to this type from the input type.

impl From<i64> for Value

fn from(v: i64) -> Self

Converts to this type from the input type.

impl From<u32> for Value

fn from(v: u32) -> Self

Converts to this type from the input type.

impl From<usize> for Value

An index or a count. One past i64::MAX cannot be a payload’s number, so it saturates there rather than wrapping negative.

fn from(v: usize) -> Self

Converts to this type from the input type.

impl MessageField for Value

fn to_value(self) -> Value

fn from_value(v: &Value) -> Option<Self>

None for a value of the wrong shape.

impl PartialEq for Value

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Value

impl TryFrom<&Value> for String

A string message read back, so ev.message::<String>() is a bare on_click("save")’s "save": the core keeps a non-map message under tag (ADR 0047), and message reads from there.

type Error = ()

The type returned in the event of a conversion error.

fn try_from(v: &Value) -> Result<Self, ()>

Performs the conversion.