Enum TypeRef 

pub enum TypeRef {
    I8,
    I16,
    I32,
    I64,
    U8,
    U16,
    U32,
    U64,
    F32,
    F64,
    Bool,
    StringUtf8,
    Bytes,
    Named(String),
    Optional(Box<TypeRef>),
    List(Box<TypeRef>),
    Map(Box<TypeRef>, Box<TypeRef>),
    Iterator(Box<TypeRef>),
}

A reference to a type in the IDL, exactly as written.

Every user-defined type (record, enum, interface, or callback interface) is a Named reference at this level; the validator resolves the name against the declarations in scope and lowers it into the resolved kind generators consume. Keeping the document model unresolved is what makes an IDL round-trip losslessly.

There is no function-typed TypeRef. Consumer-implemented behavior is expressed as a CallbackInterfaceDef referenced by name, and asynchronous producer work uses async: true. Together these cover every pattern the FFI boundary needs and keep the type system free of values the C ABI can’t represent uniformly.

Variants

I8

Signed 8-bit integer (i8).

I16

Signed 16-bit integer (i16).

I32

Signed 32-bit integer (i32).

I64

Signed 64-bit integer (i64).

U8

Unsigned 8-bit integer (u8).

U16

Unsigned 16-bit integer (u16).

U32

Unsigned 32-bit integer (u32).

U64

Unsigned 64-bit integer (u64).

F32

32-bit IEEE 754 floating-point number (f32).

F64

64-bit IEEE 754 floating-point number (f64).

Bool

Boolean (bool).

StringUtf8

UTF-8 string (string). Borrowed when passed in, owned when returned.

Bytes

Byte buffer (bytes). Borrowed when passed in, owned when returned.

Named(String)

A reference to a user-defined type (record, enum, interface, or callback interface) by its bare or dot-qualified name (Contact, shared.Status), exactly as parsed. Resolution happens in the validator, not here.

Optional(Box<TypeRef>)

Optional value (T?): either the inner type or nothing.

List(Box<TypeRef>)

Homogeneous list ([T]) of the inner element type.

Map(Box<TypeRef>, Box<TypeRef>)

Map ({K:V}) from a key type to a value type.

Iterator(Box<TypeRef>)

Lazy sequence (iter<T>) of the inner type, lowered to a next/destroy iterator object rather than a materialized collection.

Implementations

impl TypeRef

pub fn user_name(&self) -> Option<&str>

The referenced user-type name for a Named reference, or None for every other type.

pub fn walk<'a>(&'a self, f: &mut dyn FnMut(&'a TypeRef))

Walk this type and every type nested inside it (optional payloads, list elements, map keys and values, iterator items), outermost first.

Trait Implementations

impl Clone for TypeRef

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TypeRef

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TypeRef

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for TypeRef

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

Formats the value using the given formatter.

impl Eq for TypeRef

impl Hash for TypeRef

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 JsonSchema for TypeRef

Available on crate feature idl only.

Manual JsonSchema impl because TypeRef (de)serializes as a string with custom syntax: primitive names (i32, string, …), iter<{T}>, [{T}], { {K}: {V} }, {name}?, or any user-defined type name.

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(_generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl PartialEq for TypeRef

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for TypeRef

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for TypeRef