Struct yksom::vm::objects::Class

pub struct Class {
    pub path: PathBuf,
    pub instrs_off: usize,
    pub inst_vars_map: HashMap<SmartString, usize>,
    // some fields omitted
}

Fields

path: PathBuf

instrs_off: usize

Offset to this class’s instructions in VM::instrs.

inst_vars_map: HashMap<SmartString, usize>

Implementations

impl Class

pub fn new(
    vm: &VM,
    metacls: Val,
    name: Val,
    path: PathBuf,
    instrs_off: usize,
    supercls: Val,
    inst_vars_map: HashMap<SmartString, usize>,
    methods: Val,
    methods_map: HashMap<SmartString, usize>
) -> Val

pub fn name(&self, _: &VM) -> Result<Val, Box<VMError>>

pub fn get_method(&self, vm: &VM, msg: &str) -> Result<Gc<Method>, Box<VMError>>

pub fn set_metacls(&self, vm: &VM, cls_val: Val)

pub fn supercls(&self, _: &VM) -> Val

pub fn set_supercls(&self, _: &VM, cls: Val)

pub fn set_methods_class(&self, vm: &VM, cls: Val)

pub fn bootstrap(&self, vm: &VM)

pub fn fields(&self, vm: &mut VM) -> Val

pub fn methods(&self, _: &VM) -> Val

Trait Implementations

impl Debug for Class

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

Formats the value using the given formatter.

impl NotUnboxable for Class

impl Obj for Class

fn dyn_objtype(self: Gc<Self>) -> ObjType

What ObjType does this Val represent?

fn get_class(self: Gc<Self>, _: &mut VM) -> Val

What class is this object an instance of?

fn num_inst_vars(self: Gc<Self>, _: &VM) -> usize

How many instance variables does this object contain?

unsafe fn unchecked_inst_var_get(self: Gc<Self>, vm: &VM, n: usize) -> Val

Lookup an instance variable in this object. If usize exceeds the number of instance variables this will lead to undefined behaviour.

unsafe fn unchecked_inst_var_set(self: Gc<Self>, vm: &VM, n: usize, v: Val)

Set an instance variable in this object. If usize exceeds the number of instance variables this will lead to undefined behaviour.

fn hashcode(self: Gc<Self>) -> u64

What is this object’s hashcode?

fn to_array(self: Gc<Self>) -> Result<Gc<dyn Array>, Box<VMError>> where
    Self: Send, 

If (and only if) this object implements the Array trait then return a reference to this object as an Array trait object.

fn to_strval(self: Gc<Self>, _: &mut VM) -> Result<Val, Box<VMError>> where
    Self: Send, 

Convert this object to a Val that represents a SOM string.

fn inst_var_at(self: Gc<Self>, vm: &VM, i: usize) -> Result<Val, Box<VMError>> where
    Self: Send, 

Return the instance variable at i (using SOM indexing).

fn inst_var_at_put(
    self: Gc<Self>,
    vm: &VM,
    i: usize,
    v: Val
) -> Result<(), Box<VMError>> where
    Self: Send, 

Return the instance variable at i (using SOM indexing).

fn length(self: Gc<Self>) -> usize where
    Self: Send, 

What is this object’s length?

fn add(self: Gc<Self>, _: &mut VM, _: Val) -> Result<Val, Box<VMError>> where
    Self: Send, 

Produce a new Val which adds other to this.

fn and(self: Gc<Self>, _: &mut VM, _: Val) -> Result<Val, Box<VMError>> where
    Self: Send, 

Produce a new Val which performs a bitwise and with other and this.

fn div(self: Gc<Self>, _: &mut VM, _: Val) -> Result<Val, Box<VMError>> where
    Self: Send, 

Produce a new Val which divides other from this.

fn double_div(self: Gc<Self>, _: &mut VM, _: Val) -> Result<Val, Box<VMError>> where
    Self: Send, 

fn modulus(self: Gc<Self>, _: &mut VM, _: Val) -> Result<Val, Box<VMError>> where
    Self: Send, 

Produce a new Val which performs a mod operation on this with other.

fn mul(self: Gc<Self>, _: &mut VM, _: Val) -> Result<Val, Box<VMError>> where
    Self: Send, 

Produce a new Val which multiplies other to this.

fn remainder(self: Gc<Self>, _: &mut VM, _: Val) -> Result<Val, Box<VMError>> where
    Self: Send, 

Produce a new Val which returns the remainder of dividing this with other.

fn shl(self: Gc<Self>, _: &mut VM, _: Val) -> Result<Val, Box<VMError>> where
    Self: Send, 

Produce a new Val which shifts self other bits to the left.

fn shr(self: Gc<Self>, _: &mut VM, _: Val) -> Result<Val, Box<VMError>> where
    Self: Send, 

Produce a new Val which shifts self other bits to the right, treating self as if it did not have a sign bit.

fn sqrt(self: Gc<Self>, _: &mut VM) -> Result<Val, Box<VMError>> where
    Self: Send, 

Produces a new Val which is the square root of this.

fn sub(self: Gc<Self>, _: &mut VM, _: Val) -> Result<Val, Box<VMError>> where
    Self: Send, 

Produce a new Val which subtracts other from this.

fn xor(self: Gc<Self>, _: &mut VM, _: Val) -> Result<Val, Box<VMError>> where
    Self: Send, 

Produce a new Val which performs a bitwise xor with other and this

fn ref_equals(
    self: Gc<Self>,
    vm: &mut VM,
    other: Val
) -> Result<Val, Box<VMError>> where
    Self: Send, 

Is this Val reference equality equal to other? Only immutable SOM types are likely to want to override this.

fn equals(self: Gc<Self>, _: &mut VM, _: Val) -> Result<Val, Box<VMError>> where
    Self: Send, 

Does this Val equal other?

fn not_equals(self: Gc<Self>, _: &mut VM, _: Val) -> Result<Val, Box<VMError>> where
    Self: Send, 

Does this Val not equal other?

fn greater_than(self: Gc<Self>, _: &mut VM, _: Val) -> Result<Val, Box<VMError>> where
    Self: Send, 

Is this Val greater than other?

fn greater_than_equals(
    self: Gc<Self>,
    _: &mut VM,
    _: Val
) -> Result<Val, Box<VMError>> where
    Self: Send, 

Is this Val greater than or equal to other?

fn less_than(self: Gc<Self>, _: &mut VM, _: Val) -> Result<Val, Box<VMError>> where
    Self: Send, 

Is this Val less than other?

fn less_than_equals(
    self: Gc<Self>,
    _: &mut VM,
    _: Val
) -> Result<Val, Box<VMError>> where
    Self: Send, 

Is this Val less than or equal to other?

impl StaticObjType for Class

fn static_objtype() -> ObjType

Return this trait type’s static ObjType