ValueStack

Struct ValueStack 

Source
pub struct ValueStack { /* private fields */ }

Implementations§

Source§

impl ValueStack

Source

pub fn new(size: usize) -> Self

Source

pub fn as_slice(&self) -> &[Value]

Source

pub fn push<T: Into<Value>>(&mut self, value: T) -> Result<(), StackError>

Source

pub fn clear(&mut self)

Source

pub fn len(&self) -> usize

Source

pub fn pop(&mut self) -> Value

Returns Nil if the stack is empty

Source

pub fn pop_n<const N: usize>(&mut self) -> [Value; N]

Source

pub fn pop_w_offset(&mut self, offset: usize) -> Value

Pop value, treating offset as the 0 position

use cao_lang::collections::value_stack::ValueStack;
use cao_lang::prelude::Value;

let mut stack = ValueStack::new(4);
stack.push(Value::Integer(42));
let res = stack.pop_w_offset(1);
assert_eq!(res, Value::Nil);
let res = stack.pop();
assert_eq!(res, Value::Integer(42));
Source

pub fn set(&mut self, index: usize, value: Value) -> Result<Value, StackError>

Sets a value Only previous values may be set

Returns the old value

Source

pub fn get(&mut self, index: usize) -> Value

Source

pub fn clear_until(&mut self, index: usize) -> Value

Returns the very first item

Source

pub fn is_empty(&self) -> bool

Source

pub fn last(&self) -> Value

Returns Null if the stack is empty

Source

pub fn peek_last(&self, n: usize) -> Value

Returns Null if the index is out of bounds

Source

pub fn iter(&self) -> impl Iterator<Item = Value>

Source

pub fn top_location(&self) -> *const Value

Trait Implementations§

Source§

impl Debug for ValueStack

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for ValueStack

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more