Struct TyF64 

pub struct TyF64 {
    pub n: f64,
    pub ty: NumericType,
}

Fields

n: f64

ty: NumericType

Implementations

impl TyF64

pub const fn new(n: f64, ty: NumericType) -> Self

pub fn from_number(n: Number, settings: &MetaSettings) -> Self

pub fn unwrap_to_mm(&self) -> f64

Soft-deprecated. Use Self::to_mm() instead. This is legacy, and all callers should stop using this.

pub fn to_mm(&self) -> Option<f64>

The original that returns f64 was renamed to Self::unwrap_to_mm().

pub fn is_length_compatible(&self) -> bool

Returns true if this can be used as a length unit (e.g. mm, inches, etc)

pub fn unwrap_to_length_units(&self, units: UnitLength) -> f64

Soft-deprecated. Use Self::to_length_units() instead. This is legacy, and all callers should stop using this.

pub fn to_length_units(&self, units: UnitLength) -> Option<f64>

The original that returns f64 was renamed to Self::unwrap_to_length_units().

pub fn unwrap_to_degrees( &self, exec_state: &mut ExecState, source_range: SourceRange, ) -> f64

Soft-deprecated. Use Self::to_degrees() instead. This is legacy, and all callers should stop using this.

pub fn to_degrees( &self, exec_state: &mut ExecState, source_range: SourceRange, ) -> Option<f64>

The original that returns f64 was renamed to Self::unwrap_to_degrees().

pub fn unwrap_to_radians( &self, exec_state: &mut ExecState, source_range: SourceRange, ) -> f64

Soft-deprecated. Use Self::to_radians() instead. This is legacy, and all callers should stop using this.

pub fn to_radians( &self, exec_state: &mut ExecState, source_range: SourceRange, ) -> Option<f64>

The original that returns f64 was renamed to Self::unwrap_to_radians().

pub fn count(n: f64) -> Self

pub fn map_value(self, n: f64) -> Self

pub fn to_point2d( value: &[TyF64; 2], ) -> Result<Point2d<Number>, NumericSuffixTypeConvertError>

Trait Implementations

impl Clone for TyF64

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 TyF64

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

Formats the value using the given formatter.

impl<'a> FromKclValue<'a> for TyF64

fn from_kcl_val(arg: &'a KclValue) -> Option<Self>

Try to convert a KclValue into this type.

impl PartialEq for TyF64

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for TyF64

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 TyF64

impl TS for TyF64

type WithoutGenerics = TyF64

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 = TyF64

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(cfg: &Config) -> String

Identifier of this type, excluding generic parameters.

fn name(cfg: &Config) -> String

Name of this type in TypeScript, including generic parameters

fn decl_concrete(cfg: &Config) -> 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(cfg: &Config) -> String

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

fn inline(cfg: &Config) -> 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(cfg: &Config) -> 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, relative to the output directory. The returned path does not include any base directory.

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(cfg: &Config) -> Vec<Dependency>

where Self: 'static,

Resolves all dependencies of this type recursively.

fn export(cfg: &Config) -> 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(cfg: &Config) -> 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_to_string(cfg: &Config) -> 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.

impl TryFrom<TyF64> for Number

type Error = NumericSuffixTypeConvertError

The type returned in the event of a conversion error.

fn try_from(value: TyF64) -> Result<Self, Self::Error>

Performs the conversion.