Enum Shape 

pub enum Shape {
    Any,
    Bool,
    Int {
        min: i64,
        max: i64,
    },
    Float {
        bits: u32,
    },
    Str,
    Atom,
    Bytes,
    Ref {
        kinds: &'static [&'static str],
        id: ShapeFn,
    },
    Named(NamedShape),
    List(ShapeFn),
    Map(ShapeFn),
    Optional(ShapeFn),
    Struct(StructShape),
    Enum(EnumShape),
}

What a format looks like: drives an editor’s property grids and pickers, completion, hover docs and the docs’ field tables.

Variants

Any

Any value.

Bool

true or false.

Int

An integer in min..=max.

Fields

min: i64

The smallest it takes.

max: i64

The biggest it takes.

Float

A number with a fraction, bits wide (32 or 64): how a frame packs it.

Fields

bits: u32

Its width: 32 or 64.

Str

Plain text.

Atom

A name that repeats (crate::Atom): text everywhere, its number in a frame.

Bytes

Bytes as they are.

Ref

A reference of one of kinds (&[]: any kind), written @kind:id, its id of shape id (text, a number, a uid).

Fields

kinds: &'static [&'static str]

The kinds it takes (any kind if empty), the first the one written.

id: ShapeFn

The shape of its id.

Named(NamedShape)

A type of the format’s own that tools may know by name (color, date, money), stored as another shape: a tool that knows the name shows its own editor, one that doesn’t edits what it’s stored as.

List(ShapeFn)

A list of the shape.

Map(ShapeFn)

An object of any keys, every value this shape.

Optional(ShapeFn)

A value or null.

Struct(StructShape)

A struct: an object of its fields.

Enum(EnumShape)

An enum: a name, or a tagged object.

Implementations

impl Shape

pub fn named<T: NamedType>() -> Shape

The shape of T, a type of the format’s own (crate::schema::NamedType).

pub fn describe(&self) -> ShapeDoc

The shape as data, for tools in other languages (an IDE, a doc generator). Structs and enums are written once in defs and referred to by name.

Trait Implementations

impl Clone for Shape

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 Shape

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

Formats the value using the given formatter.