Enum RustType 

#[non_exhaustive]
pub enum RustType {
    Bool,
    I32,
    I64,
    U32,
    U64,
    F64,
    String,
    Value,
    Date,
    DateTime,
    Uuid,
    Bytes,
    Vec(Box<RustType>),
    Map(Box<RustType>),
    Option(Box<RustType>),
    Nullable(Box<RustType>),
    Boxed(Box<RustType>),
    Named(String),
    External {
        module: String,
        name: String,
    },
    Verbatim {
        text: String,
        derives: ForeignDerives,
    },
}

A Rust type expression usable in field/alias position.

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.

Bool

bool.

I32

i32.

I64

i64.

U32

u32.

U64

u64.

F64

f64.

String

String.

Value

serde_json::Value (free-form / empty schema).

Date

chrono::NaiveDate (format: date).

DateTime

chrono::DateTime<chrono::Utc> (format: date-time).

Uuid

uuid::Uuid (format: uuid).

Bytes

Vec<u8> (format: byte/binary).

Vec(Box<RustType>)

Vec<T>.

Map(Box<RustType>)

std::collections::HashMap<String, T>.

Option(Box<RustType>)

Option<T>.

Nullable(Box<RustType>)

A present value that can be JSON null.

Boxed(Box<RustType>)

Box<T>, added by the recursion pass to give a cyclic type a size.

Nothing in a schema asks for this. lower::recurse inserts it where a type would otherwise hold itself, directly or through other types.

Named(String)

A reference to a named (generated or external) type.

External

A reference to a type from an import-mapped module: module::Name.

Generated by another run of this generator, so it derives all three non-serde traits and carries no ForeignDerives.

Fields

module: String

name: String

Verbatim

A verbatim type expression from an x-rust-type extension, with what its x-rust-derive says the target implements.

Fields

text: String

The Rust type expression, emitted as written.

derives: ForeignDerives

Which of Debug, Clone, PartialEq the target satisfies.

Implementations

impl RustType

pub fn optional(self) -> RustType

Wrap this type in Option<..>.

pub fn is_option(&self) -> bool

Whether this type is an Option<..> (for which skip_serializing_if = "Option::is_none" is valid).

pub fn innermost(&self) -> &RustType

The type inside any Option or Box wrapper.

A Vec and a Map are not wrappers here. Each carries keywords of its own, so a rule reads the collection and not an element.

pub fn is_scalar(&self) -> bool

Whether this is a scalar the generated code compares with ==.

pub fn label(&self) -> String

The type as text, for an error message.

Emission goes through emit::emit_type, which builds tokens. This gives a reader the same type in a message that the lowering stage can write, where no token stream exists yet.

pub fn verbatim(text: impl Into<String>) -> RustType

An x-rust-type target whose x-rust-derive is absent, so it claims all three non-serde traits. The common case, and the shape every test that does not test this feature wants.

Trait Implementations

impl Clone for RustType

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 RustType

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

Formats the value using the given formatter.

impl Eq for RustType

impl PartialEq for RustType

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for RustType