Trait Schema

Source

pub trait Schema: Sized {
Show 14 methods    // Required methods
    fn shape() -> Shape;
    fn read(v: &ValueRef<'_>, cx: &mut Reader<'_>) -> Option<Self>;
    fn write(&self) -> Value;

    // Provided methods
    fn absent() -> Option<Self> { ... }
    fn skip(&self) -> bool { ... }
    fn encode(&self, w: &mut Writer) { ... }
    fn write_text(&self, w: &mut Writer) { ... }
    fn decode(d: &mut Decoder<'_>) -> Option<Self> { ... }
    fn pack(&self, p: &mut Packer) { ... }
    fn unpack(u: &mut Unpacker<'_>) -> Option<Self> { ... }
    fn pack_list(items: &[Self], p: &mut Packer) { ... }
    fn unpack_list(u: &mut Unpacker<'_>) -> Option<Vec<Self>> { ... }
    fn encode_list(items: &[Self], w: &mut Writer) { ... }
    fn decode_list(d: &mut Decoder<'_>) -> Option<Vec<Self>> { ... }
}

Expand description

#[derive(Schema)]: a type read and written as Yog Data (stores, packets, frames). A format: a type that reads, writes, encodes, packs and describes itself.

Required Methods§

Source

fn shape() -> Shape

What the format looks like.

Source

fn read(v: &ValueRef<'_>, cx: &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).

Source

fn write(&self) -> Value

The value, as the format writes it.

Provided Methods§

Source

fn absent() -> Option<Self>

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

Source

fn skip(&self) -> bool

Whether a struct leaves this field out when writing it.

Source

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

Source

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

Writes itself as text, straight (crate::text::Writer) — Schema::write’s value as text, unless the type knows better (derived ones do): no value tree is built on the way.

Source

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

Source

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

Source

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

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

Source

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

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

Source

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

A list of these out of a frame.

Source

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

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

Source

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

A list of these read straight.

Dyn Compatibility§

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Trait Schema Copy item path

Required Methods§

fn shape() -> Shape

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

fn write(&self) -> Value

Provided Methods§

fn absent() -> Option<Self>

fn skip(&self) -> bool

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

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

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

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

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

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

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

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

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

Dyn Compatibility§

Implementations on Foreign Types§

impl Schema for ()

fn shape() -> Shape

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

fn write(&self) -> Value

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

impl Schema for AdvancementDef

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

fn write_text(&self, __sd_w: &mut Writer)

fn decode(__sd_d: &mut Decoder<'_>) -> Option<AdvancementDef>

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

fn unpack(__sd_u: &mut Unpacker<'_>) -> Option<AdvancementDef>

fn shape() -> Shape

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

fn write(&self) -> Value

impl Schema for Animation

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

fn write_text(&self, __sd_w: &mut Writer)

fn decode(__sd_d: &mut Decoder<'_>) -> Option<Animation>

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

fn unpack(__sd_u: &mut Unpacker<'_>) -> Option<Animation>

fn shape() -> Shape

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

fn write(&self) -> Value

impl Schema for AnyRefOrTag

fn shape() -> Shape

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

fn write(&self) -> Value

impl Schema for Arc<str>

fn shape() -> Shape

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

fn write(&self) -> Value

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

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

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

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

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

impl Schema for ArmorMaterialDef

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

fn write_text(&self, __sd_w: &mut Writer)

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

fn unpack(__sd_u: &mut Unpacker<'_>) -> Option<ArmorMaterialDef>

fn shape() -> Shape

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

fn write(&self) -> Value

impl Schema for ArmorProps

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

fn write_text(&self, __sd_w: &mut Writer)

fn decode(__sd_d: &mut Decoder<'_>) -> Option<ArmorProps>

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

fn unpack(__sd_u: &mut Unpacker<'_>) -> Option<ArmorProps>

fn shape() -> Shape

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

fn write(&self) -> Value

impl Schema for Axis

fn shape() -> Shape

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

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

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

fn write(&self) -> Value

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

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

Trait Schema