Struct EntryObject 

pub struct EntryObject {
    pub kind: Option<Kind>,
    pub value: Value,
    pub comment: Option<String>,
    pub key: Option<String>,
    pub event: Option<String>,
    pub subtitle: Option<String>,
}

An entry’s object form: { "type": ..., "value": ..., "comment": ..., ... }.

Fields

kind: Option<Kind>

What the entry is; by default what its value is (string, number, bool).

value: Value

The text, path, color, number or flag.

comment: Option<String>

A note for whoever edits the file — never shipped.

key: Option<String>

Texts: the translation key instead of the default one.

event: Option<String>

Sounds: the sound event name.

subtitle: Option<String>

Sounds: the subtitle’s translation key.

Trait Implementations

impl Fields for EntryObject

const FIELDS: &'static [(&'static str, &'static str)]

impl Schema for EntryObject

fn encode(&self, __yog_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(__yog_d: &mut Decoder<'_>) -> Option<EntryObject>

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, __yog_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(__yog_u: &mut Unpacker<'_>) -> Option<EntryObject>

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

fn shape() -> Shape

What the format looks like.

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

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 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.