Struct Number 

pub struct Number<T = ()>(/* private fields */);

Cast a Rust type to a Typescript number type.

This can be used to opt into exporting BigInt-style Rust integer types as Typescript number when precision loss is acceptable.

Examples

This can be used as a type override.

use serde::Serialize;
use specta::Type;
use specta_typescript::Number;

#[derive(Serialize, Type)]
pub struct Demo {
    #[specta(type = Number)]
    pub field: i128,
}

Or it can be used as a wrapper type.

use serde::Serialize;
use specta::Type;
use specta_typescript::Number;

#[derive(Serialize, Type)]
pub struct Demo {
    pub field: Number<i128>,
}

Trait Implementations

impl<T: Clone> Clone for Number<T>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Number<T>

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

Formats the value using the given formatter.

impl<T: Default> Default for Number<T>

fn default() -> Self

Returns the “default value” for a type.

impl<'de, T: Deserialize<'de>> Deserialize<'de> for Number<T>

Available on crate feature serde only.

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T: Serialize> Serialize for Number<T>

Available on crate feature serde only.

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl<T> Type for Number<T>

fn definition(_: &mut Types) -> DataType

Returns a DataType that represents Self.