Enum SchemaKind 

#[repr(u8)]
pub enum SchemaKind<Id = SchemaHash> {
    Struct {
        name: String,
        fields: Vec<FieldSchema<Id>>,
    },
    Enum {
        name: String,
        variants: Vec<VariantSchema<Id>>,
    },
    Tuple {
        elements: Vec<TypeRef<Id>>,
    },
    List {
        element: TypeRef<Id>,
    },
    Map {
        key: TypeRef<Id>,
        value: TypeRef<Id>,
    },
    Array {
        element: TypeRef<Id>,
        length: u64,
    },
    Option {
        element: TypeRef<Id>,
    },
    Channel {
        direction: ChannelDirection,
        element: TypeRef<Id>,
    },
    Primitive {
        primitive_type: PrimitiveType,
    },
}

The structural kind of a type, generic over the ID representation.

Variants

Struct

Fields

name: String

The type name (e.g. “Point”). Used for matching across schema versions and for diagnostics. MUST NOT be empty.

fields: Vec<FieldSchema<Id>>

Enum

Fields

name: String

The type name (e.g. “Color”). Used for matching across schema versions and for diagnostics. MUST NOT be empty.

variants: Vec<VariantSchema<Id>>

Tuple

Fields

elements: Vec<TypeRef<Id>>

List

Fields

element: TypeRef<Id>

Map

Fields

key: TypeRef<Id>

value: TypeRef<Id>

Array

Fields

element: TypeRef<Id>

length: u64

Option

Fields

element: TypeRef<Id>

Channel

Fields

direction: ChannelDirection

element: TypeRef<Id>

Primitive

Fields

primitive_type: PrimitiveType

Implementations

impl<Id> SchemaKind<Id>

pub fn for_each_type_ref(&self, f: &mut impl FnMut(&TypeRef<Id>))

Visit every TypeRef in this schema kind.

pub fn try_map_type_refs<OtherId, E>( self, f: &mut impl FnMut(TypeRef<Id>) -> Result<TypeRef<OtherId>, E>, ) -> Result<SchemaKind<OtherId>, E>

Transform every TypeRef in this schema kind, with fallible mapping.

Trait Implementations

impl<Id: Clone> Clone for SchemaKind<Id>

fn clone(&self) -> SchemaKind<Id>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<Id: Debug> Debug for SchemaKind<Id>

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

Formats the value using the given formatter.

impl<'ʄ, Id> Facet<'ʄ> for SchemaKind<Id>

where Id: Facet<'ʄ>,

const SHAPE: &'static Shape

The shape of this type, including: whether it’s a Struct, an Enum, something else?