Enum ShapeRef 

#[non_exhaustive]
pub enum ShapeRef {
    Unit,
    Bool,
    Char,
    I8,
    I16,
    I32,
    I64,
    I128,
    Isize,
    U8,
    U16,
    U32,
    U64,
    U128,
    Usize,
    F32,
    F64,
    String,
    Bytes,
    Option(Box<ShapeRef>),
    Seq(Box<ShapeRef>),
    Array {
        item: Box<ShapeRef>,
        len: usize,
    },
    Map {
        key: Box<ShapeRef>,
        value: Box<ShapeRef>,
    },
    Tuple(Vec<ShapeRef>),
    Union(UnionShape),
    Definition(ShapeId),
    Opaque(OpaqueShape),
}

A reference to a shape node.

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.

Unit

Unit shape.

Bool

Boolean shape.

Char

Character shape.

I8

i8 shape.

I16

i16 shape.

I32

i32 shape.

I64

i64 shape.

I128

i128 shape.

Isize

isize shape.

U8

u8 shape.

U16

u16 shape.

U32

u32 shape.

U64

u64 shape.

U128

u128 shape.

Usize

usize shape.

F32

f32 shape.

F64

f64 shape.

String

UTF-8 string shape.

Bytes

Serde byte-buffer data-model shape.

Option(Box<ShapeRef>)

Optional value shape.

Seq(Box<ShapeRef>)

Sequence shape.

Array

Fixed-size array shape.

Built-in array implementations follow Serde’s supported lengths of 0 through 32. Manual implementations may construct other lengths for custom representations.

Fields

item: Box<ShapeRef>

The array item shape.

len: usize

The array length.

Map

Map shape.

Fields

key: Box<ShapeRef>

The map key shape.

value: Box<ShapeRef>

The map value shape.

Tuple(Vec<ShapeRef>)

Tuple shape.

Union(UnionShape)

A normalized union of two or more possible value shapes.

Construct unions with ShapeRef::union or ShapeRef::try_union.

Definition(ShapeId)

Named type definition reference.

Opaque(OpaqueShape)

Shape intentionally left opaque.

Implementations

impl ShapeRef

pub fn union<I>(alternatives: I) -> Self

where I: IntoIterator<Item = Self>,

Builds a normalized union from one or more possible value shapes.

Nested unions are flattened, duplicate alternatives are removed, and alternatives are sorted into a canonical order. A single distinct alternative is returned directly.

Panics

Panics when alternatives is empty. Use ShapeRef::try_union when the input may be empty.

pub fn try_union<I>(alternatives: I) -> Option<Self>

where I: IntoIterator<Item = Self>,

Tries to build a normalized union from possible value shapes.

Returns None when alternatives is empty. Nested unions are flattened, duplicate alternatives are removed, and alternatives are sorted into a canonical order. A single distinct alternative is returned directly.

pub fn is_signed_integer(&self) -> bool

Returns true if this shape contains only signed integers.

pub fn is_unsigned_integer(&self) -> bool

Returns true if this shape contains only unsigned integers.

pub fn is_integer(&self) -> bool

Returns true if this shape contains only integers.

pub fn is_float(&self) -> bool

Returns true if this shape contains only floating-point values.

pub fn is_number(&self) -> bool

Returns true if this shape contains only numeric values.

Trait Implementations

impl Clone for ShapeRef

fn clone(&self) -> ShapeRef

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ShapeRef

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

Formats the value using the given formatter.

impl Eq for ShapeRef

impl Ord for ShapeRef

fn cmp(&self, other: &ShapeRef) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for ShapeRef

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for ShapeRef

fn partial_cmp(&self, other: &ShapeRef) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for ShapeRef