Struct magnus::Float

pub struct Float(/* private fields */);

A type wrapping either a Flonum or an RFloat value.

See the ReprValue trait for additional methods available on this type. See Ruby for methods to create a Float.

Implementations

impl Float

pub fn from_value(val: Value) -> Option<Self>

Return Some(Float) if val is a Float, None otherwise.

Examples

use magnus::{eval, Float};

assert!(Float::from_value(eval("1.7272337110188893e-77").unwrap()).is_some());
assert!(Float::from_value(eval("1.7272337110188890e-77").unwrap()).is_some());
assert!(Float::from_value(eval("1").unwrap()).is_none());

pub fn from_f64(n: f64) -> Self

Create a new Float from an f64.

Panics

Panics if called from a non-Ruby thread. See Ruby::float_from_f64 for the non-panicking version.

Examples

use magnus::{rb_assert, Float};

let f = Float::from_f64(1.7272337110188893e-77);
rb_assert!("f == 1.7272337110188893e-77", f);

let f = Float::from_f64(1.7272337110188890e-77);
rb_assert!("f == 1.7272337110188890e-77", f);

pub fn to_f64(self) -> f64

Convert self to a f64.

Examples

use magnus::{eval, Float};

let f: Float = eval("2.0").unwrap();
assert_eq!(f.to_f64(), 2.0);

pub fn rationalize_with_prec(self, prec: Self) -> RRational

Returns a rational approximation of self.

Examples

use magnus::{rb_assert, Float};

let pi = Float::from_f64(3.141592);

let r = pi.rationalize_with_prec(Float::from_f64(0.001));
rb_assert!("r == 201/64r", r);

let r = pi.rationalize_with_prec(Float::from_f64(0.01));
rb_assert!("r == 22/7r", r);

let r = pi.rationalize_with_prec(Float::from_f64(0.1));
rb_assert!("r == 16/5r", r);

let r = pi.rationalize_with_prec(Float::from_f64(1.));
rb_assert!("r == 3/1r", r);

pub fn rationalize(self) -> RRational

Returns a rational approximation of self.

Examples

use magnus::{rb_assert, Float};

let pi = Float::from_f64(3.141592);
rb_assert!("r = 392699/125000r", r = pi.rationalize());

Trait Implementations

impl Clone for Float

fn clone(&self) -> Float

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Float

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

Formats the value using the given formatter.

impl Display for Float

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

Formats the value using the given formatter.

impl IntoValue for Float

fn into_value_with(self, _: &Ruby) -> Value

Convert self into Value.

fn into_value(self) -> Value

Convert self into Value.

unsafe fn into_value_unchecked(self) -> Value

Convert self into Value.

impl Numeric for Float

fn coerce_bin<T, ID, U>(self, other: T, op: ID) -> Result<U, Error>

where T: Numeric, ID: IntoId, U: TryConvert,

Apply the operator op with coercion.

fn coerce_cmp<T, ID, U>(self, other: T, op: ID) -> Result<U, Error>

where T: Numeric, ID: IntoId, U: TryConvert,

Apply the operator op with coercion.

fn coerce_relop<T, ID, U>(self, other: T, op: ID) -> Result<U, Error>

where T: Numeric, ID: IntoId, U: TryConvert,

Apply the operator op with coercion.

fn coerce_bit<T, ID, U>(self, other: T, op: ID) -> Result<U, Error>

where T: Numeric, ID: IntoId, U: TryConvert,

Apply the operator op with coercion.

impl ReprValue for Float

fn as_value(self) -> Value

Return self as a Value.

fn is_nil(self) -> bool

Returns whether self is Ruby’s nil value.

fn equal<T>(self, other: T) -> Result<bool, Error>

where T: ReprValue,

Checks for equality, delegating to the Ruby method #==.

fn eql<T>(self, other: T) -> Result<bool, Error>

where T: ReprValue,

Checks for equality, delegating to the Ruby method #eql?.

fn hash(self) -> Result<Integer, Error>

Returns an integer non-uniquely identifying self.

fn class(self) -> RClass

Returns the class that self is an instance of.

fn is_frozen(self) -> bool

Returns whether self is ‘frozen’.

fn check_frozen(self) -> Result<(), Error>

Returns an error if self is ‘frozen’.

fn freeze(self)

Mark self as frozen.

fn to_bool(self) -> bool

Convert self to a bool, following Ruby’s rules of false and nil as boolean false and everything else boolean true.

fn funcall<M, A, T>(self, method: M, args: A) -> Result<T, Error>

where M: IntoId, A: ArgList, T: TryConvert,

Call the method named method on self with args.

fn funcall_public<M, A, T>(self, method: M, args: A) -> Result<T, Error>

where M: IntoId, A: ArgList, T: TryConvert,

Call the public method named method on self with args.

fn check_funcall<M, A, T>(self, method: M, args: A) -> Option<Result<T, Error>>

where M: IntoId, A: ArgList, T: TryConvert,

If self responds to the method named method, call it with args.

fn funcall_with_block<M, A, T>( self, method: M, args: A, block: Proc ) -> Result<T, Error>

where M: IntoId, A: ArgList, T: TryConvert,

Call the method named method on self with args and block.

fn block_call<M, A, R, T>( self, method: M, args: A, block: fn(_: &[Value], _: Option<Proc>) -> R ) -> Result<T, Error>

where M: IntoId, A: ArgList, R: BlockReturn, T: TryConvert,

Call the method named method on self with args and block.

fn respond_to<M>(self, method: M, include_private: bool) -> Result<bool, Error>

where M: IntoId,

Check if self responds to the given Ruby method.

fn to_r_string(self) -> Result<RString, Error>

Convert self to a Ruby String.

unsafe fn to_s(&self) -> Result<Cow<'_, str>, Error>

Convert self to a Rust string.

fn inspect(self) -> String

Convert self to its Ruby debug representation.

unsafe fn classname(&self) -> Cow<'_, str>

Return the name of self’s class.

fn is_kind_of<T>(self, class: T) -> bool

where T: ReprValue + Module,

Returns whether or not self is an instance of class.

fn enumeratorize<M, A>(self, method: M, args: A) -> Enumerator

where M: IntoSymbol, A: ArgList,

Generate an Enumerator from method on self, passing args to method.

impl TryConvert for Float

fn try_convert(val: Value) -> Result<Self, Error>

Convert val into Self.

impl Copy for Float