Enum cairo_vm::types::relocatable::MaybeRelocatable

pub enum MaybeRelocatable {
    RelocatableValue(Relocatable),
    Int(Felt),
}

Variants

RelocatableValue(Relocatable)

Int(Felt)

Implementations

impl MaybeRelocatable

pub fn add_int(
    &self,
    other: &Felt
) -> Result<MaybeRelocatable, VirtualMachineError>

Adds a Felt to self

pub fn add_usize(&self, other: usize) -> MaybeRelocatable

Adds a usize to self

pub fn add(
    &self,
    other: &MaybeRelocatable
) -> Result<MaybeRelocatable, VirtualMachineError>

Adds a MaybeRelocatable to self Cant add two relocatable values

pub fn sub(
    &self,
    other: &MaybeRelocatable
) -> Result<MaybeRelocatable, VirtualMachineError>

Substracts two MaybeRelocatable values and returns the result as a MaybeRelocatable value. Only values of the same type may be substracted. Relocatable values can only be substracted if they belong to the same segment.

pub fn divmod(
    &self,
    other: &MaybeRelocatable
) -> Result<(MaybeRelocatable, MaybeRelocatable), VirtualMachineError>

Performs integer division and module on a MaybeRelocatable::Int by another MaybeRelocatable::Int and returns the quotient and reminder.

pub fn get_int_ref(&self) -> Result<&Felt, VirtualMachineError>

pub fn get_relocatable(&self) -> Result<Relocatable, VirtualMachineError>

Trait Implementations

impl Clone for MaybeRelocatable

fn clone(&self) -> MaybeRelocatable

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MaybeRelocatable

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for MaybeRelocatable

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
    __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for MaybeRelocatable

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

Formats the value using the given formatter.

impl From<&Felt> for MaybeRelocatable

fn from(val: &Felt) -> Self

Converts to this type from the input type.

impl From<&MaybeRelocatable> for MaybeRelocatable

fn from(other: &MaybeRelocatable) -> Self

Converts to this type from the input type.

impl From<&Relocatable> for MaybeRelocatable

fn from(rel: &Relocatable) -> Self

Converts to this type from the input type.

impl From<(isize, usize)> for MaybeRelocatable

fn from(index_offset: (isize, usize)) -> Self

Converts to this type from the input type.

impl From<Felt> for MaybeRelocatable

fn from(num: Felt) -> Self

Converts to this type from the input type.

impl From<MaybeRelocatable> for CairoArg

fn from(other: MaybeRelocatable) -> Self

Converts to this type from the input type.

impl From<Relocatable> for MaybeRelocatable

fn from(rel: Relocatable) -> Self

Converts to this type from the input type.

impl From<usize> for MaybeRelocatable

fn from(num: usize) -> Self

Converts to this type from the input type.

impl Hash for MaybeRelocatable

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where
    H: Hasher,
    Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq<MaybeRelocatable> for MaybeRelocatable

fn eq(&self, other: &MaybeRelocatable) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd<MaybeRelocatable> for MaybeRelocatable

fn partial_cmp(&self, other: &MaybeRelocatable) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for MaybeRelocatable

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where
    __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&MaybeRelocatable> for Relocatable

type Error = MemoryError

The type returned in the event of a conversion error.

fn try_from(other: &MaybeRelocatable) -> Result<Self, MemoryError>

Performs the conversion.

impl TryInto<Relocatable> for MaybeRelocatable

type Error = MemoryError

The type returned in the event of a conversion error.

fn try_into(self) -> Result<Relocatable, MemoryError>

Performs the conversion.

impl Eq for MaybeRelocatable

impl StructuralEq for MaybeRelocatable

impl StructuralPartialEq for MaybeRelocatable