Enum WhiskerValue 

pub enum WhiskerValue {
    Null,
    Bool(bool),
    Int(i64),
    Float(f64),
    String(String),
    Bytes(Vec<u8>),
    Array(Vec<WhiskerValue>),
    Map(BTreeMap<String, WhiskerValue>),
    Error(String),
}

Tagged-union variant set passed between Rust and the platform side — module args/returns and event payloads alike.

String/Bytes/Array/Map are Rust-allocated and dropped on scope exit. Conversion to/from the C WhiskerValueRaw form happens at the FFI boundary in whisker-driver.

This enum is intentionally closed (not #[non_exhaustive]): it models a sealed tagged union mirroring the C WhiskerValueRaw discriminator, and the FFI encoder in whisker-driver must handle every variant exhaustively. Adding a variant is a deliberate, breaking wire-format change touching both sides of the boundary, so callers may rely on matching it exhaustively.

Variants

Null

Bool(bool)

Int(i64)

Float(f64)

String(String)

Bytes(Vec<u8>)

Array(Vec<WhiskerValue>)

Map(BTreeMap<String, WhiskerValue>)

String-keyed map. BTreeMap for deterministic iteration order — important for snapshot tests and the proc-macro layer that codegen’s destructuring patterns based on key order.

Error(String)

Bridge / platform reported failure. Carries a UTF-8 description; the proc macro lifts this into a typed Result::Err.

Implementations

impl WhiskerValue

pub fn map<I, K>(entries: I) -> Self

where I: IntoIterator<Item = (K, WhiskerValue)>, K: Into<String>,

Convenience constructor that wraps a BTreeMap literal. Lets test code write WhiskerValue::map([("k", WhiskerValue::Int(1))]) without importing BTreeMap.

pub fn args<I>(items: I) -> Self

where I: IntoIterator<Item = WhiskerValue>,

Build the { "args": [ … ] } params object that Whisker module element methods (@WhiskerUIMethod) decode — their forwarders read positional arguments from params.args. Built-in Lynx methods read named fields directly and use map instead; this helper is for module-element handles like VideoHandle invoking through the unified ElementRef::invoke.

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

Returns the Error message if self is the Error variant. Convenience for callers that want to bail on any failure without matching the variant manually.

pub fn deserialize_into<T: DeserializeOwned>(&self) -> Result<T, String>

Deserialize this value tree into a typed T.

Used by the typed-event layer: a Fn(TouchEvent) handler receives the event body as a WhiskerValue, then deserialize_into::<TouchEvent>() recovers the struct. On failure (shape mismatch, missing required field) returns Err with a human-readable message — the event binding logs it together with the raw value rather than silently dropping the handler call.

pub fn to_json(&self) -> Value

Lower this value tree into a serde_json::Value. In-memory only — the target of deserialize_into.

pub fn from_json(v: Value) -> WhiskerValue

Lift a serde_json::Value into a WhiskerValue.

Trait Implementations

impl Clone for WhiskerValue

fn clone(&self) -> WhiskerValue

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WhiskerValue

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

Formats the value using the given formatter.

impl Default for WhiskerValue

fn default() -> WhiskerValue

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for WhiskerValue

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&str> for WhiskerValue

fn from(v: &str) -> Self

Converts to this type from the input type.

impl From<()> for WhiskerValue

fn from(_: ()) -> Self

Converts to this type from the input type.

impl From<String> for WhiskerValue

fn from(v: String) -> Self

Converts to this type from the input type.

impl<T> From<Vec<T>> for WhiskerValue

where T: Into<WhiskerValue>,

fn from(v: Vec<T>) -> Self

Converts to this type from the input type.

impl From<Vec<u8>> for WhiskerValue

fn from(v: Vec<u8>) -> Self

Converts to this type from the input type.

impl From<bool> for WhiskerValue

fn from(v: bool) -> Self

Converts to this type from the input type.

impl From<f32> for WhiskerValue

fn from(v: f32) -> Self

Converts to this type from the input type.

impl From<f64> for WhiskerValue

fn from(v: f64) -> Self

Converts to this type from the input type.

impl From<i32> for WhiskerValue

fn from(v: i32) -> Self

Converts to this type from the input type.

impl From<i64> for WhiskerValue

fn from(v: i64) -> Self

Converts to this type from the input type.

impl From<u32> for WhiskerValue

fn from(v: u32) -> Self

Converts to this type from the input type.

impl PartialEq for WhiskerValue

fn eq(&self, other: &WhiskerValue) -> 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 StructuralPartialEq for WhiskerValue

impl TryFrom<WhiskerValue> for ()

type Error = String

The type returned in the event of a conversion error.

fn try_from(v: WhiskerValue) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<WhiskerValue> for bool

type Error = String

The type returned in the event of a conversion error.

fn try_from(v: WhiskerValue) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<WhiskerValue> for i64

type Error = String

The type returned in the event of a conversion error.

fn try_from(v: WhiskerValue) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<WhiskerValue> for i32

type Error = String

The type returned in the event of a conversion error.

fn try_from(v: WhiskerValue) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<WhiskerValue> for f64

type Error = String

The type returned in the event of a conversion error.

fn try_from(v: WhiskerValue) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<WhiskerValue> for f32

type Error = String

The type returned in the event of a conversion error.

fn try_from(v: WhiskerValue) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<WhiskerValue> for String

type Error = String

The type returned in the event of a conversion error.

fn try_from(v: WhiskerValue) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<WhiskerValue> for Vec<u8>

type Error = String

The type returned in the event of a conversion error.

fn try_from(v: WhiskerValue) -> Result<Self, Self::Error>

Performs the conversion.