Enum Shape 

pub enum Shape {
    Any,
    Bool,
    Int {
        min: i64,
        max: i64,
    },
    Float,
    Str,
    Text,
    Image,
    Color,
    Res,
    Ref(&'static [&'static str]),
    Tag(&'static [&'static str]),
    RefOrTag(&'static [&'static str]),
    RefOrImage(&'static [&'static str]),
    List(ShapeFn),
    Map(ShapeFn),
    Optional(ShapeFn),
    Struct(StructShape),
    Enum(EnumShape),
}

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

Variants

Any

Any value.

Bool

Int

Fields

min: i64

max: i64

Float

Str

Plain text.

Text

Yog text, a @Set.key resource, or @kind:id (that content’s name).

Image

An image source or a @Set.key image resource.

Color

#RRGGBB/#AARRGGBB or a @Set.key color resource.

Res

A mod resource, @Set.key.

Ref(&'static [&'static str])

Content of a kind ("": any kind, written @kind:id).

Tag(&'static [&'static str])

A tag of content of a kind.

RefOrTag(&'static [&'static str])

Content of a kind or a tag of it.

RefOrImage(&'static [&'static str])

Content of a kind (@item:…) or an image source.

List(ShapeFn)

Map(ShapeFn)

An object of any keys, every value this shape.

Optional(ShapeFn)

A value or null.

Struct(StructShape)

Enum(EnumShape)

Implementations

impl Shape

pub fn describe(&self) -> Value

The shape as Yog Data, for tools in other languages (Yog-IDLE). 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.