Enum ScalarType 

#[non_exhaustive]
pub enum ScalarType {
    Unit,
    Bool,
    Char,
    Str,
    String,
    CowStr,
    F32,
    F64,
    U8,
    U16,
    U32,
    U64,
    U128,
    USize,
    I8,
    I16,
    I32,
    I64,
    I128,
    ISize,
    ConstTypeId,
}

All scalar types supported out of the box by facet.

This enum allows identifying whether a Shape represents a known scalar type (primitives, strings, network addresses, etc.), which is useful for serializers, deserializers, and introspection code.

Example

use facet_core::{Facet, ScalarType};

assert_eq!(u32::SHAPE.scalar_type(), Some(ScalarType::U32));
assert_eq!(bool::SHAPE.scalar_type(), Some(ScalarType::Bool));

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 tuple ().

Bool

Primitive type bool.

Char

Primitive type char.

Str

Primitive type str (or &str).

String

alloc::string::String.

CowStr

alloc::borrow::Cow<'_, str>.

F32

Primitive type f32.

F64

Primitive type f64.

U8

Primitive type u8.

U16

Primitive type u16.

U32

Primitive type u32.

U64

Primitive type u64.

U128

Primitive type u128.

USize

Primitive type usize.

I8

Primitive type i8.

I16

Primitive type i16.

I32

Primitive type i32.

I64

Primitive type i64.

I128

Primitive type i128.

ISize

Primitive type isize.

ConstTypeId

facet_core::ConstTypeId.

Implementations

impl ScalarType

pub fn try_from_shape(shape: &Shape) -> Option<Self>

Infer the scalar type from a shape definition.

Returns Some(ScalarType) if the shape represents a known scalar type, or None for non-scalar types like structs, enums, lists, or maps.

Trait Implementations

impl Clone for ScalarType

fn clone(&self) -> ScalarType

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ScalarType

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

Formats the value using the given formatter.

impl Hash for ScalarType

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for ScalarType

fn cmp(&self, other: &ScalarType) -> 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.

impl PartialEq for ScalarType

fn eq(&self, other: &ScalarType) -> 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 PartialOrd for ScalarType

fn partial_cmp(&self, other: &ScalarType) -> 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 Copy for ScalarType

impl Eq for ScalarType

impl StructuralPartialEq for ScalarType