Enum spacetimedb_sats::builtin_type::BuiltinType

pub enum BuiltinType {
    Bool,
    I8,
    U8,
    I16,
    U16,
    I32,
    U32,
    I64,
    U64,
    I128,
    U128,
    F32,
    F64,
    String,
    Array(ArrayType),
    Map(Box<MapType>),
}

Represents the built-in types in SATS.

Some of these types are nominal in our otherwise structural type system.

Variants

Bool

The bool type. Values BuiltinValue::Bool(b) will have this type.

I8

The I8 type. Values BuiltinValue::I8(v) will have this type.

U8

The U8 type. Values BuiltinValue::U8(v) will have this type.

I16

The I16 type. Values BuiltinValue::I16(v) will have this type.

U16

The U16 type. Values BuiltinValue::U16(v) will have this type.

I32

The I32 type. Values BuiltinValue::I32(v) will have this type.

U32

The U32 type. Values BuiltinValue::U32(v) will have this type.

I64

The I64 type. Values BuiltinValue::I64(v) will have this type.

U64

The U64 type. Values BuiltinValue::U64(v) will have this type.

I128

The I128 type. Values BuiltinValue::I128(v) will have this type.

U128

The U128 type. Values BuiltinValue::U128(v) will have this type.

F32

The F32 type. Values BuiltinValue::F32(v) will have this type.

F64

The F64 type. Values BuiltinValue::F64(v) will have this type.

String

The UTF-8 encoded String type. Values BuiltinValue::String(s) will have this type.

This type exists for convenience and because it is easy to just use Rust’s String (UTF-8) as opposed to rolling your own equivalent byte-array based UTF-8 encoding.

Array(ArrayType)

The type of array values where elements are of a base type elem_ty. Values BuiltinValue::Array(array) will have this type.

Map(Box<MapType>)

The type of map values consisting of a key type key_ty and value ty. Values BuiltinValue::Map(map) will have this type. The order of entries in a map value is observable.

Implementations

impl BuiltinType

pub fn is_bool(&self) -> bool

Returns true if this is a BuiltinType::Bool, otherwise false

pub fn is_i8(&self) -> bool

Returns true if this is a BuiltinType::I8, otherwise false

pub fn is_u8(&self) -> bool

Returns true if this is a BuiltinType::U8, otherwise false

pub fn is_i16(&self) -> bool

Returns true if this is a BuiltinType::I16, otherwise false

pub fn is_u16(&self) -> bool

Returns true if this is a BuiltinType::U16, otherwise false

pub fn is_i32(&self) -> bool

Returns true if this is a BuiltinType::I32, otherwise false

pub fn is_u32(&self) -> bool

Returns true if this is a BuiltinType::U32, otherwise false

pub fn is_i64(&self) -> bool

Returns true if this is a BuiltinType::I64, otherwise false

pub fn is_u64(&self) -> bool

Returns true if this is a BuiltinType::U64, otherwise false

pub fn is_i128(&self) -> bool

Returns true if this is a BuiltinType::I128, otherwise false

pub fn is_u128(&self) -> bool

Returns true if this is a BuiltinType::U128, otherwise false

pub fn is_f32(&self) -> bool

Returns true if this is a BuiltinType::F32, otherwise false

pub fn is_f64(&self) -> bool

Returns true if this is a BuiltinType::F64, otherwise false

pub fn is_string(&self) -> bool

Returns true if this is a BuiltinType::String, otherwise false

pub fn is_array(&self) -> bool

Returns true if this is a BuiltinType::Array, otherwise false

pub fn as_array_mut(&mut self) -> Option<&mut ArrayType>

Optionally returns mutable references to the inner fields if this is a BuiltinType::Array, otherwise None

pub fn as_array(&self) -> Option<&ArrayType>

Optionally returns references to the inner fields if this is a BuiltinType::Array, otherwise None

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

Returns the inner fields if this is a BuiltinType::Array, otherwise returns back the enum in the Err case of the result

pub fn is_map(&self) -> bool

Returns true if this is a BuiltinType::Map, otherwise false

pub fn as_map_mut(&mut self) -> Option<&mut Box<MapType>>

Optionally returns mutable references to the inner fields if this is a BuiltinType::Map, otherwise None

pub fn as_map(&self) -> Option<&Box<MapType>>

Optionally returns references to the inner fields if this is a BuiltinType::Map, otherwise None

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

Returns the inner fields if this is a BuiltinType::Map, otherwise returns back the enum in the Err case of the result

impl BuiltinType

pub fn as_value(&self) -> AlgebraicValue

pub fn from_value( value: &AlgebraicValue ) -> Result<BuiltinType, ValueDeserializeError>

Trait Implementations

impl Clone for BuiltinType

fn clone(&self) -> BuiltinType

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BuiltinType

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for BuiltinType

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given deserializer.

impl From<BuiltinType> for AlgebraicType

fn from(original: BuiltinType) -> AlgebraicType

Converts to this type from the input type.

impl Hash for BuiltinType

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 MetaType for BuiltinType

fn meta_type() -> AlgebraicType

Returns the type structure of this type as an AlgebraicType.

impl Ord for BuiltinType

fn cmp(&self, other: &BuiltinType) -> 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 + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for BuiltinType

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for BuiltinType

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Serialize for BuiltinType

fn serialize<S: Serializer>(&self, __serializer: S) -> Result<S::Ok, S::Error>

Serialize self in the data format of S using the provided serializer.

impl Eq for BuiltinType

impl StructuralPartialEq for BuiltinType