Struct magnus::Float

#[repr(transparent)]
pub struct Float(_);

A type wrapping either a Flonum value or a Value known to be an instance of Float.

All Value methods should be available on this type through Deref, but some may be missed by this documentation.

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());

pub fn from_f64(n: f64) -> Self

Create a new Float from an f64.

Examples

use magnus::{eval, Float};

let res: bool = eval!("f == 1.7272337110188893e-77", f = Float::from_f64(1.7272337110188893e-77)).unwrap();
assert!(res);
let res: bool = eval!("f == 1.7272337110188890e-77", f = Float::from_f64(1.7272337110188890e-77)).unwrap();
assert!(res);

pub fn to_f64(self) -> f64

Convert self to a f64.

Examples

use magnus::{eval, Float};

assert_eq!(eval::<Float>("2.0").unwrap().to_f64(), 2.0);

Methods from Deref<Target = Value>

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

Convert self to a Rust string.

Safety

This may return a direct view of memory owned and managed by Ruby. Ruby may modify or free the memory backing the returned str, the caller must ensure this does not happen.

This can be used safely by immediately calling into_owned on the return value.

Examples

use magnus::{eval, QTRUE};

let value = QTRUE;
// safe as we neve give Ruby a chance to free the string.
let s = unsafe { value.to_s() }.unwrap().into_owned();
assert_eq!(s, "true");

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

Return the name of self’s class.

Safety

Ruby may modify or free the memory backing the returned str, the caller must ensure this does not happen.

This can be used safely by immediately calling into_owned on the return value.

Examples

use magnus::{eval, RHash};

let value = RHash::new();
// safe as we never give Ruby a chance to free the string.
let s = unsafe { value.classname() }.into_owned();
assert_eq!(s, "Hash");

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 Deref for Float

type Target = Value

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Display for Float

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

Formats the value using the given formatter.

impl From<Float> for Value

fn from(val: Float) -> Self

Converts to this type from the input type.

impl TryConvert for Float

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

Convert val into Self.

impl Copy for Float

impl ReprValue for Float