Struct 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() -> Queue<T>

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() -> Queue<T>

Returns the “default value” for a type.

impl<T> NestedDecode for Queue<T>

where T: NestedDecode,

Deserializes like a Vec.

fn dep_decode_or_handle_err<I, H>( input: &mut I, h: H, ) -> Result<Queue<T>, <H as DecodeErrorHandler>::HandledErr>

where I: NestedDecodeInput, H: DecodeErrorHandler,

Version of dep_decode that can handle errors as soon as they occur. For instance in can exit immediately and make sure that if it returns, it is a success. By not deferring error handling, this can lead to somewhat smaller bytecode.

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

where I: NestedDecodeInput,

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.

impl<T> NestedEncode for Queue<T>

where T: NestedEncode,

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

fn dep_encode_or_handle_err<O, H>( &self, dest: &mut O, h: H, ) -> Result<(), <H as EncodeErrorHandler>::HandledErr>

where O: NestedEncodeOutput, H: EncodeErrorHandler,

Version of dep_encode that can handle errors as soon as they occur. For instance in can exit immediately and make sure that if it returns, it is a success. By not deferring error handling, this can lead to somewhat smaller bytecode.

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

where O: NestedEncodeOutput,

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

impl<T> TopDecode for Queue<T>

where T: NestedDecode,

Deserializes like a Vec.

fn top_decode_or_handle_err<I, H>( input: I, h: H, ) -> Result<Queue<T>, <H as DecodeErrorHandler>::HandledErr>

where I: TopDecodeInput, H: DecodeErrorHandler,

Version of top_decode that can handle errors as soon as they occur. For instance it can exit immediately and make sure that if it returns, it is a success. By not deferring error handling, this can lead to somewhat smaller bytecode.

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

where I: TopDecodeInput,

Attempt to deserialize the value from input.

impl<T> TopEncode for Queue<T>

where T: NestedEncode,

fn top_encode_or_handle_err<O, H>( &self, output: O, h: H, ) -> Result<(), <H as EncodeErrorHandler>::HandledErr>

where O: TopEncodeOutput, H: EncodeErrorHandler,

Version of top_encode that can handle errors as soon as they occur. For instance in can exit immediately and make sure that if it returns, it is a success. By not deferring error handling, this can lead to somewhat smaller bytecode.

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

where O: TopEncodeOutput,

Attempt to serialize the value to ouput.

impl<T> TypeAbi for Queue<T>

where T: TypeAbi,

type Unmanaged = Queue<T>

fn type_name() -> String

fn type_names() -> TypeNames

fn type_name_rust() -> String

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

where TDC: TypeDescriptionContainer,

A type can provide more than its own name. 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.

impl<T> TypeAbiFrom<Queue<T>> for Queue<T>

where T: TypeAbi,