Enum NumericType

pub enum NumericType {
    Known(UnitType),
    Default {
        len: UnitLen,
        angle: UnitAngle,
    },
    Unknown,
    Any,
}

Variants

Known(UnitType)

Default

Fields

len: UnitLen

angle: UnitAngle

Unknown

Any

Implementations

impl NumericType

pub const fn count() -> Self

pub const fn mm() -> Self

pub const fn radians() -> Self

pub const fn degrees() -> Self

pub fn combine_eq(a: TyF64, b: TyF64) -> (f64, f64, NumericType)

Combine two types when we expect them to be equal, erring on the side of less coercion. To be precise, only adjusting one number or the other when they are of known types.

This combinator function is suitable for comparisons where uncertainty should be handled by the user.

pub fn combine_eq_coerce(a: TyF64, b: TyF64) -> (f64, f64, NumericType)

Combine two types when we expect them to be equal, erring on the side of more coercion. Including adjusting when we are certain about only one type.

This combinator function is suitable for situations where the user would almost certainly want the types to be coerced together, for example two arguments to the same function or two numbers in an array being used as a point.

Prefer to use combine_eq if possible since using that prioritises correctness over ergonomics.

pub fn combine_eq_array(input: &[TyF64]) -> (Vec<f64>, NumericType)

pub fn combine_mul(a: TyF64, b: TyF64) -> (f64, f64, NumericType)

Combine two types for multiplication-like operations.

pub fn combine_div(a: TyF64, b: TyF64) -> (f64, f64, NumericType)

Combine two types for division-like operations.

pub fn combine_mod(a: TyF64, b: TyF64) -> (f64, f64, NumericType)

Combine two types for modulo-like operations.

pub fn from_parsed(suffix: NumericSuffix, settings: &MetaSettings) -> Self

pub fn is_fully_specified(&self) -> bool

pub fn expect_length(&self) -> UnitLen

pub fn as_length(&self) -> Option<UnitLen>

Trait Implementations

impl Clone for NumericType

fn clone(&self) -> NumericType

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NumericType

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

Formats the value using the given formatter.

impl Default for NumericType

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for NumericType

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<UnitAngle> for NumericType

fn from(value: UnitAngle) -> Self

Converts to this type from the input type.

impl From<UnitLen> for NumericType

fn from(value: UnitLen) -> Self

Converts to this type from the input type.

impl JsonSchema for NumericType

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 NumericType

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for NumericType

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TS for NumericType

type WithoutGenerics = NumericType

If this type does not have generic parameters, then WithoutGenerics should just be Self. If the type does have generic parameters, then all generic parameters must be replaced with a dummy type, e.g ts_rs::Dummy or (). The only requirement for these dummy types is that EXPORT_TO must be None.

type OptionInnerType = NumericType

If the implementing type is std::option::Option<T>, then this associated type is set to T. All other implementations of TS should set this type to Self instead.

fn ident() -> String

Identifier of this type, excluding generic parameters.

fn name() -> String

Name of this type in TypeScript, including generic parameters

fn decl_concrete() -> String

Declaration of this type using the supplied generic arguments. The resulting TypeScript definition will not be generic. For that, see TS::decl(). If this type is not generic, then this function is equivalent to TS::decl().

fn decl() -> String

Declaration of this type, e.g. type User = { user_id: number, ... }. This function will panic if the type has no declaration.

fn inline() -> String

Formats this types definition in TypeScript, e.g { user_id: number }. This function will panic if the type cannot be inlined.

fn inline_flattened() -> String

Flatten a type declaration.
This function will panic if the type cannot be flattened.

fn visit_generics(v: &mut impl TypeVisitor)

where Self: 'static,

Iterates over all type parameters of this type.

fn output_path() -> Option<PathBuf>

Returns the output path to where T should be exported.
The returned path does not include the base directory from TS_RS_EXPORT_DIR.

fn visit_dependencies(v: &mut impl TypeVisitor)

where Self: 'static,

Iterates over all dependency of this type.

fn docs() -> Option<String>

JSDoc comment to describe this type in TypeScript - when TS is derived, docs are automatically read from your doc comments or #[doc = ".."] attributes

fn dependencies() -> Vec<Dependency>

where Self: 'static,

Resolves all dependencies of this type recursively.

fn export() -> Result<(), ExportError>

where Self: 'static,

Manually export this type to the filesystem. To export this type together with all of its dependencies, use TS::export_all.

fn export_all() -> Result<(), ExportError>

where Self: 'static,

Manually export this type to the filesystem, together with all of its dependencies.
To export only this type, without its dependencies, use TS::export.

fn export_all_to(out_dir: impl AsRef<Path>) -> Result<(), ExportError>

where Self: 'static,

Manually export this type into the given directory, together with all of its dependencies.
To export only this type, without its dependencies, use TS::export.

fn export_to_string() -> Result<String, ExportError>

where Self: 'static,

Manually generate bindings for this type, returning a String.
This function does not format the output, even if the format feature is enabled.

fn default_output_path() -> Option<PathBuf>

Returns the output path to where T should be exported.

impl Copy for NumericType

impl StructuralPartialEq for NumericType