Struct NumericValue

Source
pub struct NumericValue(/* private fields */);
Expand description

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§

Source§

impl Clone for NumericValue

Source§

fn clone(&self) -> NumericValue

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for NumericValue

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for NumericValue

Source§

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

Formats the value using the given formatter. Read more
Source§

impl IntoValue for NumericValue

Source§

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

Convert self into Value.
Source§

fn into_value(self) -> Value

Available on crate feature old-api only.
Convert self into Value. Read more
Source§

unsafe fn into_value_unchecked(self) -> Value

Convert self into Value. Read more
Source§

impl Numeric for NumericValue

Source§

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. Read more
Source§

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. Read more
Source§

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. Read more
Source§

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. Read more
Source§

impl ReprValue for NumericValue

Source§

fn as_value(self) -> Value

Return self as a Value.
Source§

fn is_nil(self) -> bool

Returns whether self is Ruby’s nil value. Read more
Source§

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

Checks for equality, delegating to the Ruby method #==. Read more
Source§

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

Checks for equality, delegating to the Ruby method #eql?. Read more
Source§

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

Returns an integer non-uniquely identifying self. Read more
Source§

fn class(self) -> RClass

Returns the class that self is an instance of. Read more
Source§

fn is_frozen(self) -> bool

Returns whether self is ‘frozen’. Read more
Source§

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

Returns an error if self is ‘frozen’. Read more
Source§

fn freeze(self)

Mark self as frozen. Read more
Source§

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. Read more
Source§

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. Read more
Source§

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. Read more
Source§

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. Read more
Source§

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. Read more
Source§

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. Read more
Source§

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. Read more
Source§

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

Convert self to a Ruby String. Read more
Source§

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

Convert self to a Rust string. Read more
Source§

fn inspect(self) -> String

Convert self to its Ruby debug representation. Read more
Source§

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

Return the name of self’s class. Read more
Source§

fn is_kind_of<T>(self, class: T) -> bool
where T: ReprValue + Module,

Returns whether or not self is an instance of class. Read more
Source§

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. Read more
Source§

impl TryConvert for NumericValue

Source§

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

Convert val into Self.
Source§

impl Copy for NumericValue

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> AsRawValue for T
where T: ReprValue,

Source§

fn as_raw(self) -> u64

Available on crate feature rb-sys only.
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Inspect for T
where T: Debug,

Source§

fn inspect(&self) -> String

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> BlockReturn for T
where T: BlockReturn,

Source§

impl<T> Locate for T
where T: ReprValue,

Source§

impl<T> Mark for T
where T: ReprValue,

Source§

impl<T> ReturnValue for T
where T: ReturnValue,