Struct magnus::RRational

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

A Value pointer to a RRational struct, Ruby’s internal representation of rational numbers.

See the ReprValue trait for additional methods available on this type. See Ruby for methods to create an RRational.

Implementations

impl RRational

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

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

Examples

use magnus::{eval, RRational};

assert!(RRational::from_value(eval("1/2r").unwrap()).is_some());
assert!(RRational::from_value(eval("0.5").unwrap()).is_none());

pub fn new(num: i64, den: NonZeroI64) -> Self

Create a new RRational.

Panics

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

Examples

use std::num::NonZeroI64;

use magnus::RRational;

let rational = RRational::new(2, NonZeroI64::new(4).unwrap());
assert_eq!(rational.to_string(), "1/2");

pub fn num(self) -> Integer

Returns self’s numerator.

Examples

use std::num::NonZeroI64;

use magnus::RRational;

let rational = RRational::new(6, NonZeroI64::new(9).unwrap());
assert_eq!(rational.num().to_i64().unwrap(), 2);

pub fn den(self) -> Integer

Returns self’s denominator.

Examples

use std::num::NonZeroI64;

use magnus::RRational;

let rational = RRational::new(6, NonZeroI64::new(9).unwrap());
assert_eq!(rational.den().to_i64().unwrap(), 3);

Trait Implementations

impl Clone for RRational

fn clone(&self) -> RRational

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RRational

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

Formats the value using the given formatter.

impl Display for RRational

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

Formats the value using the given formatter.

impl IntoValue for RRational

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 RRational

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 RRational

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 RRational

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

Convert val into Self.

impl Copy for RRational