Enum Shape

#[non_exhaustive]
pub enum Shape {
    Bottom,
    Any,
    Optional(Box<Shape>),
    Null,
    Bool,
    StringT,
    Integer,
    Floating,
    VecT {
        elem_type: Box<Shape>,
    },
    Struct {
        fields: LinkedHashMap<String, Shape>,
    },
    Tuple(Vec<Shape>, u64),
    MapT {
        val_type: Box<Shape>,
    },
    Opaque(String),
}

The type representing the inferred structure

A word of caution: Everything in this crate is “internal API”, but for this type in particular, since it is very central to how json_typegen works, be prepared that major breaking changes may need to be made to this in the future.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Bottom

Bottom represents the absence of any inference information

Any

Any represents conflicting inference information that can not be represented by any single shape

Optional(Box<Shape>)

Optional(T) represents that a value is nullable, or not always present

Null

Equivalent to Optional(Bottom), Null represents optionality with no further information

Bool

StringT

Integer

Floating

VecT

Fields

elem_type: Box<Shape>

Struct

Fields

fields: LinkedHashMap<String, Shape>

Tuple(Vec<Shape>, u64)

MapT

Fields

val_type: Box<Shape>

Opaque(String)

Trait Implementations

impl Clone for Shape

fn clone(&self) -> Shape

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.

impl PartialEq for Shape

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Shape