Enum UnitLength 

pub enum UnitLength {
    Centimeters,
    Feet,
    Inches,
    Meters,
    Millimeters,
    Yards,
}

The valid types of length units.

Variants

Centimeters

Centimeters https://en.wikipedia.org/wiki/Centimeter

Feet

Feet https://en.wikipedia.org/wiki/Foot_(unit)

Inches

Inches https://en.wikipedia.org/wiki/Inch

Meters

Meters https://en.wikipedia.org/wiki/Meter

Millimeters

Millimeters https://en.wikipedia.org/wiki/Millimeter

Yards

Yards https://en.wikipedia.org/wiki/Yard

Implementations

impl UnitLength

pub fn convert_to(&self, to: UnitLength, input: f64) -> f64

Do a unit conversion for this type.

impl UnitLength

pub fn as_measurement(self, value: f64) -> Length

Convert to measurement.

Trait Implementations

impl Clone for UnitLength

fn clone(&self) -> UnitLength

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for UnitLength

impl Debug for UnitLength

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

Formats the value using the given formatter.

impl Default for UnitLength

fn default() -> UnitLength

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for UnitLength

fn deserialize<__D>( __deserializer: __D, ) -> Result<UnitLength, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for UnitLength

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

Formats the value using the given formatter.

impl Eq for UnitLength

impl From<UnitLength> for NumericSuffix

fn from(value: UnitLength) -> Self

Converts to this type from the input type.

impl FromStr for UnitLength

type Err = ParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<UnitLength, <UnitLength as FromStr>::Err>

Parses a string s to return a value of this type.

impl FromStrRegex for UnitLength

fn from_str_regex() -> String

Returns a regex pattern for strings that might be parseable by FromStr.

impl Hash for UnitLength

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl JsonSchema for UnitLength

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 Ord for UnitLength

fn cmp(&self, other: &UnitLength) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for UnitLength

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

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

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 PartialOrd for UnitLength

fn partial_cmp(&self, other: &UnitLength) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for UnitLength

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for UnitLength

impl TS for UnitLength

type WithoutGenerics = UnitLength

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

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 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 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 UnitLength: '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 UnitLength: 'static,

Iterates over all dependency of this type.

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 ToKcmc for UnitLength

type Equivalent = UnitLength

fn to_kcmc(self) -> Self::Equivalent

Converts this unit of measurement from kcl_api to its equivalent for kcmc.