Enum Value 

pub enum Value {
    Null,
    Bool(bool),
    Int(i64),
    Float(f64),
    Str(String),
    List(Vec<Value>),
    Map(Map),
    Ref(Ref),
    Tag(Ref),
    Res(Res),
    Lang(String),
    Text(String),
    Image(String),
    Color(u32),
    Bytes(Vec<u8>),
}

A Yog Data value.

The text form has no syntax of its own for the typed values (Ref, Tag, Res, Text, Image, Color): they’re written as strings ("@item:minecraft:stick"), so every file stays JSON, and the schema of a field says which type its string is. The binary form keeps the type.

Variants

Null

Bool(bool)

Int(i64)

Float(f64)

Str(String)

List(Vec<Value>)

Map(Map)

Ref(Ref)

@item:minecraft:stick — content of some kind, by id.

Tag(Ref)

@tag:item:minecraft:planks — a tag of content of some kind.

Res(Res)

@Strings.title — a mod resource (.yres entry).

Lang(String)

@lang:gui.done — a translation key of the game’s or a mod’s lang files.

Text(String)

Yog text: {b|bold} and {#8d6acc|color}.

Image(String)

An image source: sprite:button, mymod:gui/logo, item:minecraft:stick.

Color(u32)

0xAARRGGBB.

Bytes(Vec<u8>)

Bytes as they are — a picture, a sound — written @bytes:<base64> as text.

Implementations

impl Value

pub fn borrow<'a>(&'a self, arena: &'a Bump) -> ValueRef<'a>

This value, borrowed (lists and maps in arena) — what schemas read.

impl Value

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

The type’s name, for messages: "a string", "a list", …

pub fn is_null(&self) -> bool

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

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

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

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

The string of a Str (and of the string-like typed values: Text, Image).

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

pub fn as_map(&self) -> Option<&Map>

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

self[key] of a map, None for anything else.

pub fn at(&self, path: &Path) -> Option<&Value>

The value at path.

pub fn at_mut(&mut self, segs: &[Seg]) -> Option<&mut Value>

The value segs lead to, to change.

Trait Implementations

impl Clone for Value

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

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<&str> for Value

fn from(s: &str) -> Self

Converts to this type from the input type.

impl From<Map> for Value

fn from(m: Map) -> 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<Vec<Value>> for Value

fn from(l: Vec<Value>) -> Self

Converts to this type from the input type.

impl From<bool> for Value

fn from(b: bool) -> Self

Converts to this type from the input type.

impl From<f64> for Value

fn from(f: f64) -> Self

Converts to this type from the input type.

impl From<i64> for Value

fn from(n: i64) -> Self

Converts to this type from the input type.

impl PartialEq for Value

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

Equality operator ==.

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

Inequality operator !=.

impl Schema for Value

fn shape() -> Shape

What the format looks like.

fn read(v: &ValueRef<'_>, _: &mut Reader<'_>) -> Option<Self>

Reads v. Problems go to cx at its current path; None when the value couldn’t be read (the problem is in cx).

fn write(&self) -> Value

The value, as the format writes it.

fn absent() -> Option<Self>

The value of a field that isn’t there — None: the field is required.

fn skip(&self) -> bool

Whether a struct leaves this field out when writing it.

fn encode(&self, w: &mut Writer)

Writes itself in the binary form, straight — Schema::write’s value encoded, unless the type knows better (derived ones do).

fn decode(d: &mut Decoder<'_>) -> Option<Self>

Reads itself from the binary form, straight; None when it isn’t what Schema::encode writes — then read_bytes reads the slow way, which says what’s wrong. Through a value unless the type knows better (derived ones do).

fn pack(&self, p: &mut Packer)

Packs itself into a frame (crate::frame): its binary form as bytes, unless the type packs itself (derived ones and plain types do).

fn unpack(u: &mut Unpacker<'_>) -> Option<Self>

Reads itself out of a frame; None if the bytes aren’t what Schema::pack writes.

fn pack_list(items: &[Self], p: &mut Packer)

A list of these packed: a count, then each one (floats raw).

fn unpack_list(u: &mut Unpacker<'_>) -> Option<Vec<Self>>

A list of these out of a frame.

fn encode_list(items: &[Self], w: &mut Writer)

A list of these written straight (numbers pack theirs).

fn decode_list(d: &mut Decoder<'_>) -> Option<Vec<Self>>

A list of these read straight.

impl StructuralPartialEq for Value