Enum Def 

#[non_exhaustive]
#[repr(C)]
pub enum Def {
    Undefined,
    Scalar,
    Map(MapDef),
    Set(SetDef),
    List(ListDef),
    Array(ArrayDef),
    NdArray(NdArrayDef),
    Slice(SliceDef),
    Option(OptionDef),
    Result(ResultDef),
    Pointer(PointerDef),
    DynamicValue(DynamicValueDef),
}

The semantic definition of a shape: is it more like a scalar, a map, a list?

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.

Undefined

Undefined - you can interact with the type through Type and VTableView.

Scalar

Scalar — those don’t have a def, they’re not composed of other things. You can interact with them through VTableView.

e.g. u32, String, bool, SocketAddr, etc.

Map(MapDef)

Map — keys are dynamic (and strings, sorry), values are homogeneous

e.g. HashMap<String, T>

Set(SetDef)

Unique set of homogenous values

e.g. HashSet<T>

List(ListDef)

Ordered list of homogenous values, variable size

e.g. Vec<T>

Array(ArrayDef)

Fixed-size array of homogeneous values, fixed size

e.g. [T; 3]

NdArray(NdArrayDef)

n-dimensional array of homogeneous values, fixed size

e.g. Vector<T>, Matrix<T>, Tensor<T>

Slice(SliceDef)

Slice - a reference to a contiguous sequence of elements

e.g. [T]

Option(OptionDef)

Option

e.g. Option<T>

Result(ResultDef)

Result

e.g. Result<T, E>

Pointer(PointerDef)

Pointer types like Arc<T>, Rc<T>, etc.

DynamicValue(DynamicValueDef)

Dynamic value that can hold any type at runtime.

e.g. facet_value::Value, serde_json::Value

Implementations

impl Def

pub const fn map_builder( vtable: &'static MapVTable, k: &'static Shape, v: &'static Shape, ) -> DefMapBuilder

Create a builder for a Map definition.

Example

let def = Def::map_builder(&MAP_VTABLE, K::SHAPE, V::SHAPE).build();

pub const fn set_builder( vtable: &'static SetVTable, t: &'static Shape, ) -> DefSetBuilder

Create a builder for a Set definition.

Example

let def = Def::set_builder(&SET_VTABLE, T::SHAPE).build();

pub const fn list_builder( vtable: &'static ListVTable, t: &'static Shape, ) -> DefListBuilder

Create a builder for a List definition.

Example

let def = Def::list_builder(&LIST_VTABLE, T::SHAPE).build();

pub const fn array_builder( vtable: &'static ArrayVTable, t: &'static Shape, n: usize, ) -> DefArrayBuilder

Create a builder for an Array definition.

Example

let def = Def::array_builder(&ARRAY_VTABLE, T::SHAPE, 10).build();

pub const fn option_builder( vtable: &'static OptionVTable, t: &'static Shape, ) -> DefOptionBuilder

Create a builder for an Option definition.

Example

let def = Def::option_builder(&OPTION_VTABLE, T::SHAPE).build();

pub const fn result_builder( vtable: &'static ResultVTable, t: &'static Shape, e: &'static Shape, ) -> DefResultBuilder

Create a builder for a Result definition.

Example

let def = Def::result_builder(&RESULT_VTABLE, T::SHAPE, E::SHAPE).build();

pub fn into_scalar(self) -> Result<(), Self>

Returns the ScalarDef wrapped in an Ok if this is a Def::Scalar.

pub fn into_map(self) -> Result<MapDef, Self>

Returns the MapDef wrapped in an Ok if this is a Def::Map.

pub fn into_set(self) -> Result<SetDef, Self>

Returns the SetDef wrapped in an Ok if this is a Def::Set.

pub fn into_list(self) -> Result<ListDef, Self>

Returns the ListDef wrapped in an Ok if this is a Def::List.

pub fn into_array(self) -> Result<ArrayDef, Self>

Returns the ArrayDef wrapped in an Ok if this is a Def::Array.

pub fn into_ndarray(self) -> Result<NdArrayDef, Self>

Returns the NdArrayDef wrapped in an Ok if this is a Def::NdArray.

pub fn into_slice(self) -> Result<SliceDef, Self>

Returns the SliceDef wrapped in an Ok if this is a Def::Slice.

pub fn into_option(self) -> Result<OptionDef, Self>

Returns the OptionDef wrapped in an Ok if this is a Def::Option.

pub fn into_result(self) -> Result<ResultDef, Self>

Returns the ResultDef wrapped in an Ok if this is a Def::Result.

pub fn into_pointer(self) -> Result<PointerDef, Self>

Returns the PointerDef wrapped in an Ok if this is a Def::Pointer.

pub fn into_dynamic_value(self) -> Result<DynamicValueDef, Self>

Returns the DynamicValueDef wrapped in an Ok if this is a Def::DynamicValue.

pub const fn default_type(&self) -> Type

Returns the default Type for this Def.

This is used by ShapeBuilder to infer the ty field from def. For most Def variants, this returns Type::User(UserType::Opaque). Array and Slice have corresponding Type::Sequence variants.

Trait Implementations

impl Clone for Def

fn clone(&self) -> Def

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Def

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

Formats the value using the given formatter.

impl Facet<'_> for Def

const SHAPE: &'static Shape

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

impl Copy for Def