Enum ShapeNode 

pub enum ShapeNode {
    Any,
    Bool,
    Int {
        min: i64,
        max: i64,
    },
    Float {
        bits: u32,
    },
    String,
    Atom,
    Bytes,
    Ref {
        of: Vec<KindName>,
        id: Box<ShapeNode>,
    },
    Named {
        name: String,
        of: Box<ShapeNode>,
    },
    List {
        of: Box<ShapeNode>,
    },
    Map {
        of: Box<ShapeNode>,
    },
    Optional {
        of: Box<ShapeNode>,
    },
    Def {
        name: String,
    },
}

One shape as data, tagged by kind; a struct or enum is a def, its definition written once in the description’s defs.

Variants

Any

Any value.

Bool

true or false.

Int

An integer in min..=max.

Fields

min: i64

The least it may be.

max: i64

The most it may be.

Float

A number with a fraction, bits wide.

Fields

bits: u32

32 or 64.

String

Plain text.

Atom

A name that repeats.

Bytes

Bytes as they are.

Ref

A reference of one of of (any kind if empty), its id of shape id.

Fields

of: Vec<KindName>

The kinds it takes.

id: Box<ShapeNode>

The shape of its id.

Named

A type tools may know by name, stored as of.

Fields

name: String

What tools know it by.

of: Box<ShapeNode>

What it’s stored as.

List

A list of of.

Fields

of: Box<ShapeNode>

Each item’s shape.

Map

An object of any keys, every value of.

Fields

of: Box<ShapeNode>

Each value’s shape.

Optional

of or null.

Fields

of: Box<ShapeNode>

The shape when it’s there.

Def

The struct or enum name, defined in defs.

Fields

name: String

Its name in defs.

Trait Implementations

impl Clone for ShapeNode

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 ShapeNode

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

Formats the value using the given formatter.

impl PartialEq for ShapeNode

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

Equality operator ==.

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

Inequality operator !=.

impl Schema for ShapeNode

fn shape() -> Shape

What the format looks like.

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

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 ShapeNode