Struct NumericValue

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

Wrapper type for a Value known to be an instance of Ruby’s Numeric class.

See the ReprValue trait for additional methods available on this type.

Examples

use std::num::NonZeroI64;

use magnus::{numeric::NumericValue, prelude::*, Error, Ruby};

fn example(ruby: &Ruby) -> Result<(), Error> {
    let a = ruby.integer_from_i64(1);
    let b = ruby.rational_new(1, NonZeroI64::new(2).unwrap());
    let c = ruby.float_from_f64(0.3);
    let d = ruby.integer_from_i64(4);

    let result: NumericValue = a.coerce_bin(b, "+")?;
    let result: NumericValue = result.coerce_bin(c, "+")?;
    let result: NumericValue = result.coerce_bin(d, "+")?;
    assert_eq!(f64::try_convert(result.as_value())?, 5.8);

    Ok(())
}

Trait Implementations

impl Clone for NumericValue

fn clone(&self) -> NumericValue

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NumericValue

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

Formats the value using the given formatter.

impl Display for NumericValue

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

Formats the value using the given formatter.

impl IntoValue for NumericValue

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

Convert self into Value.

fn into_value(self) -> Value

Available on crate feature old-api only.

Convert self into Value.

unsafe fn into_value_unchecked(self) -> Value

Convert self into Value.

impl Numeric for NumericValue

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 NumericValue

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(&Ruby, &[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 NumericValue

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

Convert val into Self.

impl Copy for NumericValue