Struct dharitri_wasm::types::Queue

pub struct Queue<T> { /* private fields */ }

A simple queue struct that is able to push and pop without moving elements. New items are pushed at the end, just like for a regular Vec. When popping, instead of performing a regular Vec remove that would shift items, a start index is moved up 1 position. When serializing, items before the start index are ignored.

Implementations

impl<T> Queue<T>

pub fn new() -> Self

impl<T> Queue<T>

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

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

pub fn push(&mut self, value: T)

pub fn peek(&self) -> Option<&T>

Returns a referenece to the first item in the queue, without removing it. Returns None if the queue is empty.

pub fn peek_mut(&mut self) -> Option<&mut T>

Returns a mutable referenece to the first item in the queue, without removing it. Returns None if the queue is empty.

pub fn pop(&mut self) -> Option<&T>

Removes the first element from the queue and returns a reference to it. Does not physically extract the element from the underlying structure. Does nothing and returns None if the queue is empty.

Trait Implementations

impl<T> Default for Queue<T>

fn default() -> Self

Returns the “default value” for a type.

impl<T: NestedDecode> NestedDecode for Queue<T>

Deserializes like a Vec.

fn dep_decode<I: NestedDecodeInput>(input: &mut I) -> Result<Self, DecodeError>

Attempt to deserialise the value from input, using the format of an object nested inside another structure. In case of success returns the deserialized value and the number of bytes consumed during the operation.

fn dep_decode_or_exit<I: NestedDecodeInput, ExitCtx: Clone>( input: &mut I, c: ExitCtx, exit: fn(_: ExitCtx, _: DecodeError) -> ! ) -> Self

Version of top_decode that exits quickly in case of error. Its purpose is to create smaller implementations in cases where the application is supposed to exit directly on decode error.

impl<T: NestedEncode> NestedEncode for Queue<T>

Serializes identically to a Vec, entries before start index are ignored.

fn dep_encode<O: NestedEncodeOutput>( &self, dest: &mut O ) -> Result<(), EncodeError>

NestedEncode to output, using the format of an object nested inside another structure. Does not provide compact version.

fn dep_encode_or_exit<O: NestedEncodeOutput, ExitCtx: Clone>( &self, dest: &mut O, c: ExitCtx, exit: fn(_: ExitCtx, _: EncodeError) -> ! )

Version of top_decode that exits quickly in case of error. Its purpose is to create smaller implementations in cases where the application is supposed to exit directly on decode error.

impl<T: NestedDecode> TopDecode for Queue<T>

Deserializes like a Vec.

fn top_decode<I: TopDecodeInput>(input: I) -> Result<Self, DecodeError>

Attempt to deserialize the value from input.

fn top_decode_or_exit<I: TopDecodeInput, ExitCtx: Clone>( input: I, c: ExitCtx, exit: fn(_: ExitCtx, _: DecodeError) -> ! ) -> Self

Version of top_decode that exits quickly in case of error. Its purpose is to create smaller implementations in cases where the application is supposed to exit directly on decode error.

impl<T: NestedEncode> TopEncode for Queue<T>

fn top_encode<O: TopEncodeOutput>(&self, output: O) -> Result<(), EncodeError>

Attempt to serialize the value to ouput.

fn top_encode_or_exit<O: TopEncodeOutput, ExitCtx: Clone>( &self, output: O, c: ExitCtx, exit: fn(_: ExitCtx, _: EncodeError) -> ! )

Version of top_decode that exits quickly in case of error. Its purpose is to create smaller bytecode implementations in cases where the application is supposed to exit directly on decode error.

impl<T: TypeAbi> TypeAbi for Queue<T>

fn type_name() -> String

fn provide_type_descriptions<TDC: TypeDescriptionContainer>( accumulator: &mut TDC )

A type can provide more than its own description. For instance, a struct can also provide the descriptions of the type of its fields. TypeAbi doesn’t care for the exact accumulator type, which is abstracted by the TypeDescriptionContainer trait.