Struct gluon_vm::api::Data

pub struct Data<'a>(_);

Stores values of variants and records.

Implementations

impl<'a> Data<'a>

pub fn tag(&self) -> VmTag

The tag of this variant. If this value is a variant, the tag is the zero-based index of the variant that is present, in order of the declaration.

Use this method to find out what variant you are dealing with, before extracting data from it.

Examples

type OneOfFour =
    | First
    | Second
    | Third
    | Fourth

let val = First // has the tag '0'
let val = Fourth // has the tag '3'

pub fn len(&self) -> usize

Returns the number of fields of this value.

pub fn get(&self, index: usize) -> Option<ValueRef<'a>>

Retrieves the value of the field at index, like get_variant, but does not wrap it in a Variants struct.

pub fn iter(&self) -> impl Iterator<Item = Variants<'a>>

Creates an iterator over the fields of this value.

pub fn get_variant(&self, index: usize) -> Option<Variants<'a>>

Retrieves the value of the field at index. This is useful if you cannot name the field (like in a variant). If the value is a record, use lookup_field instead.

pub fn lookup_field(&self, thread: &Thread, name: &str) -> Option<Variants<'a>>

Retrieves the field name from this record.

Trait Implementations

impl<'a> Clone for Data<'a>

fn clone(&self) -> Data<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Data<'a>

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

Formats the value using the given formatter.

impl<'a> PartialEq<Data<'a>> for Data<'a>

fn eq(&self, other: &Data<'a>) -> bool

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

fn ne(&self, other: &Data<'a>) -> bool

This method tests for !=.

impl<'a> StructuralPartialEq for Data<'a>