Struct yksom::vm::objects::String_

pub struct String_ { /* fields omitted */ }

Implementations

impl String_

pub fn new_str(vm: &mut VM, s: SmartString) -> Val

pub fn new_sym(vm: &mut VM, s: SmartString) -> Val

pub fn symbol_to_string_(
    vm: &mut VM,
    v: Val
) -> Result<Gc<String_>, Box<VMError>>

If the value v represents a String_ which is an instance of the SOM Symbol class (and not the SOM String class!), return a reference to the underlying String_ or an InstanceTypeError otherwise.

pub fn as_str(&self) -> &str

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

Concatenate this string with another string and return the result.

pub fn substring(
    &self,
    vm: &mut VM,
    start: usize,
    end: usize
) -> Result<Val, Box<VMError>>

pub fn to_string_(&self, vm: &mut VM) -> Result<Val, Box<VMError>>

pub fn to_symbol(&self, vm: &mut VM) -> Result<Val, Box<VMError>>

pub fn set_cls(&self, cls: Val)

Trait Implementations

impl Debug for String_

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

Formats the value using the given formatter.

impl NotUnboxable for String_

impl Obj for String_

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 to_strval(self: Gc<Self>, _: &mut VM) -> Result<Val, Box<VMError>>

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

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

What is this object’s hashcode?

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

What is this object’s length?

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

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

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

Does this Val equal other?

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 num_inst_vars(self: Gc<Self>, _: &VM) -> usize where
    Self: Send, 

How many instance variables does this object contain?

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).

unsafe fn unchecked_inst_var_get(self: Gc<Self>, _: &VM, _: usize) -> Val where
    Self: Send, 

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, _: usize, _: Val) where
    Self: Send, 

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

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 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 String_

fn static_objtype() -> ObjType

Return this trait type’s static ObjType