Enum koto_runtime::KNumber

pub enum KNumber {
    F64(f64),
    I64(i64),
}

The Number type used by the Koto runtime

The number can be either an f64 or an i64 depending on usage.

Variants

F64(f64)

I64(i64)

Implementations

impl KNumber

pub fn abs(self) -> Self

Returns the absolute value of the number

pub fn ceil(self) -> Self

Returns the smallest integer greater than or equal to the number

pub fn floor(self) -> Self

Returns the largest integer less than or equal to the number

pub fn round(self) -> Self

Returns the integer closest to the number

Half-way values get rounded away from zero.

pub fn is_f64(self) -> bool

Returns true if the number is represented by an f64

pub fn is_i64(self) -> bool

Returns true if the number is represented by an i64

pub fn is_i64_in_f64_range(&self) -> bool

Returns true if the integer version of the number is representable by an f64

pub fn is_finite(self) -> bool

Returns true if the number is not NaN or infinity

pub fn is_nan(self) -> bool

Returns true if the number is NaN

pub fn pow(self, other: Self) -> Self

Returns the result of raising self to the power of other

If both inputs are i64s then the result will also be an i64, otherwise the result will be an f64.

pub fn to_bits(self) -> u64

Returns the value transmuted to a u64

pub fn as_i64(self) -> i64

Returns the number as an i64, calling floor if the number is an f64

Trait Implementations

impl Add for &KNumber

type Output = KNumber

The resulting type after applying the + operator.

fn add(self, other: &KNumber) -> KNumber

Performs the + operation.

impl Add for KNumber

type Output = KNumber

The resulting type after applying the + operator.

fn add(self, other: KNumber) -> KNumber

Performs the + operation.

impl Clone for KNumber

fn clone(&self) -> KNumber

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for KNumber

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

Formats the value using the given formatter.

impl Display for KNumber

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

Formats the value using the given formatter.

impl Div for &KNumber

type Output = KNumber

The resulting type after applying the / operator.

fn div(self, other: &KNumber) -> KNumber

Performs the / operation.

impl Div for KNumber

type Output = KNumber

The resulting type after applying the / operator.

fn div(self, other: KNumber) -> KNumber

Performs the / operation.

impl From<&KNumber> for f32

fn from(n: &KNumber) -> f32

Converts to this type from the input type.

impl From<&KNumber> for f64

fn from(n: &KNumber) -> f64

Converts to this type from the input type.

impl From<&KNumber> for i32

fn from(n: &KNumber) -> i32

Converts to this type from the input type.

impl From<&KNumber> for i64

fn from(n: &KNumber) -> i64

Converts to this type from the input type.

impl From<&KNumber> for isize

fn from(n: &KNumber) -> isize

Converts to this type from the input type.

impl From<&KNumber> for u32

fn from(n: &KNumber) -> u32

Converts to this type from the input type.

impl From<&KNumber> for u64

fn from(n: &KNumber) -> u64

Converts to this type from the input type.

impl From<&KNumber> for usize

fn from(n: &KNumber) -> usize

Converts to this type from the input type.

impl From<&f32> for KNumber

fn from(n: &f32) -> KNumber

Converts to this type from the input type.

impl From<&f64> for KNumber

fn from(n: &f64) -> KNumber

Converts to this type from the input type.

impl From<&i16> for KNumber

fn from(n: &i16) -> KNumber

Converts to this type from the input type.

impl From<&i32> for KNumber

fn from(n: &i32) -> KNumber

Converts to this type from the input type.

impl From<&i64> for KNumber

fn from(n: &i64) -> KNumber

Converts to this type from the input type.

impl From<&i8> for KNumber

fn from(n: &i8) -> KNumber

Converts to this type from the input type.

impl From<&isize> for KNumber

fn from(n: &isize) -> KNumber

Converts to this type from the input type.

impl From<&u16> for KNumber

fn from(n: &u16) -> KNumber

Converts to this type from the input type.

impl From<&u32> for KNumber

fn from(n: &u32) -> KNumber

Converts to this type from the input type.

impl From<&u64> for KNumber

fn from(n: &u64) -> KNumber

Converts to this type from the input type.

impl From<&u8> for KNumber

fn from(n: &u8) -> KNumber

Converts to this type from the input type.

impl From<&usize> for KNumber

fn from(n: &usize) -> KNumber

Converts to this type from the input type.

impl From<KNumber> for KValue

fn from(value: KNumber) -> Self

Converts to this type from the input type.

impl From<KNumber> for f32

fn from(n: KNumber) -> f32

Converts to this type from the input type.

impl From<KNumber> for f64

fn from(n: KNumber) -> f64

Converts to this type from the input type.

impl From<KNumber> for i32

fn from(n: KNumber) -> i32

Converts to this type from the input type.

impl From<KNumber> for i64

fn from(n: KNumber) -> i64

Converts to this type from the input type.

impl From<KNumber> for isize

fn from(n: KNumber) -> isize

Converts to this type from the input type.

impl From<KNumber> for u32

fn from(n: KNumber) -> u32

Converts to this type from the input type.

impl From<KNumber> for u64

fn from(n: KNumber) -> u64

Converts to this type from the input type.

impl From<KNumber> for usize

fn from(n: KNumber) -> usize

Converts to this type from the input type.

impl From<f32> for KNumber

fn from(n: f32) -> KNumber

Converts to this type from the input type.

impl From<f64> for KNumber

fn from(n: f64) -> KNumber

Converts to this type from the input type.

impl From<i16> for KNumber

fn from(n: i16) -> KNumber

Converts to this type from the input type.

impl From<i32> for KNumber

fn from(n: i32) -> KNumber

Converts to this type from the input type.

impl From<i64> for KNumber

fn from(n: i64) -> KNumber

Converts to this type from the input type.

impl From<i8> for KNumber

fn from(n: i8) -> KNumber

Converts to this type from the input type.

impl From<isize> for KNumber

fn from(n: isize) -> KNumber

Converts to this type from the input type.

impl From<u16> for KNumber

fn from(n: u16) -> KNumber

Converts to this type from the input type.

impl From<u32> for KNumber

fn from(n: u32) -> KNumber

Converts to this type from the input type.

impl From<u64> for KNumber

fn from(n: u64) -> KNumber

Converts to this type from the input type.

impl From<u8> for KNumber

fn from(n: u8) -> KNumber

Converts to this type from the input type.

impl From<usize> for KNumber

fn from(n: usize) -> KNumber

Converts to this type from the input type.

impl Hash for KNumber

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

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 Mul for &KNumber

type Output = KNumber

The resulting type after applying the * operator.

fn mul(self, other: &KNumber) -> KNumber

Performs the * operation.

impl Mul for KNumber

type Output = KNumber

The resulting type after applying the * operator.

fn mul(self, other: KNumber) -> KNumber

Performs the * operation.

impl Neg for &KNumber

type Output = KNumber

The resulting type after applying the - operator.

fn neg(self) -> KNumber

Performs the unary - operation.

impl Neg for KNumber

type Output = KNumber

The resulting type after applying the - operator.

fn neg(self) -> KNumber

Performs the unary - operation.

impl Ord for KNumber

fn cmp(&self, other: &Self) -> 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 + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq<f32> for KNumber

fn eq(&self, b: &f32) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

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

impl PartialEq<f64> for KNumber

fn eq(&self, b: &f64) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

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

impl PartialEq<i16> for KNumber

fn eq(&self, b: &i16) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

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

impl PartialEq<i32> for KNumber

fn eq(&self, b: &i32) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

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

impl PartialEq<i64> for KNumber

fn eq(&self, b: &i64) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

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

impl PartialEq<i8> for KNumber

fn eq(&self, b: &i8) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

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

impl PartialEq<isize> for KNumber

fn eq(&self, b: &isize) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

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

impl PartialEq<u16> for KNumber

fn eq(&self, b: &u16) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

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

impl PartialEq<u32> for KNumber

fn eq(&self, b: &u32) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

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

impl PartialEq<u64> for KNumber

fn eq(&self, b: &u64) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

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

impl PartialEq<u8> for KNumber

fn eq(&self, b: &u8) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

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

impl PartialEq<usize> for KNumber

fn eq(&self, b: &usize) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

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

impl PartialEq for KNumber

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd<f32> for KNumber

fn partial_cmp(&self, b: &f32) -> Option<Ordering>

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl PartialOrd<f64> for KNumber

fn partial_cmp(&self, b: &f64) -> Option<Ordering>

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl PartialOrd<i16> for KNumber

fn partial_cmp(&self, b: &i16) -> Option<Ordering>

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl PartialOrd<i32> for KNumber

fn partial_cmp(&self, b: &i32) -> Option<Ordering>

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl PartialOrd<i64> for KNumber

fn partial_cmp(&self, b: &i64) -> Option<Ordering>

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl PartialOrd<i8> for KNumber

fn partial_cmp(&self, b: &i8) -> Option<Ordering>

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl PartialOrd<isize> for KNumber

fn partial_cmp(&self, b: &isize) -> Option<Ordering>

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl PartialOrd<u16> for KNumber

fn partial_cmp(&self, b: &u16) -> Option<Ordering>

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl PartialOrd<u32> for KNumber

fn partial_cmp(&self, b: &u32) -> Option<Ordering>

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl PartialOrd<u64> for KNumber

fn partial_cmp(&self, b: &u64) -> Option<Ordering>

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl PartialOrd<u8> for KNumber

fn partial_cmp(&self, b: &u8) -> Option<Ordering>

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl PartialOrd<usize> for KNumber

fn partial_cmp(&self, b: &usize) -> Option<Ordering>

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl PartialOrd for KNumber

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Rem for &KNumber

type Output = KNumber

The resulting type after applying the % operator.

fn rem(self, other: &KNumber) -> KNumber

Performs the % operation.

impl Rem for KNumber

type Output = KNumber

The resulting type after applying the % operator.

fn rem(self, other: KNumber) -> KNumber

Performs the % operation.

impl Sub for &KNumber

type Output = KNumber

The resulting type after applying the - operator.

fn sub(self, other: &KNumber) -> KNumber

Performs the - operation.

impl Sub for KNumber

type Output = KNumber

The resulting type after applying the - operator.

fn sub(self, other: KNumber) -> KNumber

Performs the - operation.

impl Copy for KNumber

impl Eq for KNumber