Skip to main content

CanonicalType

Enum CanonicalType 

Source
pub enum CanonicalType {
Show 25 variants Text, Varchar(Option<u32>), Char(Option<u32>), SmallInt, Int, BigInt, Real, Double, Decimal(Option<(u8, u8)>), Boolean, Uuid, Json, Jsonb, Timestamp, TimestampNtz, Date, Time, Timetz, Bytes, Serial, BigSerial, Asset, AssetArray, Array(Box<CanonicalType>), Custom(String),
}
Expand description

Standard logical types that package configs may declare.

All string aliases accepted in JSON are normalised to one of these variants by parse_canonical. Unknown strings fall through to CanonicalType::Custom so that existing packages using raw SQL type names continue to work unchanged.

Variants§

§

Text

Unbounded unicode text (TEXT / VARCHAR without limit).

§

Varchar(Option<u32>)

Variable-length text with optional length cap.

§

Char(Option<u32>)

Fixed-length text.

§

SmallInt

16-bit integer.

§

Int

32-bit integer.

§

BigInt

64-bit integer.

§

Real

32-bit floating point.

§

Double

64-bit floating point (default for "float").

§

Decimal(Option<(u8, u8)>)

Fixed-precision decimal. Params: (precision, scale).

§

Boolean

Boolean true/false.

§

Uuid

UUID (128-bit universally unique identifier).

§

Json

JSON document. Dialects may use a richer binary form (e.g. JSONB in Postgres).

§

Jsonb

Explicitly request the binary JSON form where available; degrades to JSON/TEXT elsewhere.

§

Timestamp

Timestamp with time zone. Always stores timezone information.

§

TimestampNtz

Timestamp without time zone (use sparingly — prefer CanonicalType::Timestamp).

§

Date

Calendar date (no time component).

§

Time

Time of day without time zone.

§

Timetz

Time of day with time zone.

§

Bytes

Binary data.

§

Serial

Auto-incrementing 32-bit integer primary key.

§

BigSerial

Auto-incrementing 64-bit integer primary key.

§

Asset

SDK pseudo-type: a single asset stored as a relative path string.

§

AssetArray

SDK pseudo-type: a list of assets stored as a JSON array of path strings.

§

Array(Box<CanonicalType>)

Typed array of another canonical type (e.g. text[], uuid[]).

§

Custom(String)

Pass-through for schema-qualified enums (e.g. "myschema.status") and any raw SQL type string not matched by the canonical parser. Rendered verbatim in DDL.

Trait Implementations§

Source§

impl Clone for CanonicalType

Source§

fn clone(&self) -> CanonicalType

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for CanonicalType

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for CanonicalType

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for CanonicalType

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FromRef<T> for T
where T: Clone,

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
Source§

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more