Struct Pop

pub struct Pop { /* private fields */ }

Pop an element from a list. Performs bounds check.

Only supports lists with statically sized elements.

Behavior

BEFORE: _ *list
AFTER:  _ [element: ElementType]

Preconditions

• the argument *list points to a properly BFieldCodec-encoded list
• the list *list points must be non-empty
• all input arguments are properly BFieldCodec encoded

Postconditions

None.

Implementations

impl Pop

pub const EMPTY_LIST_ERROR_ID: i128 = 400i128

pub const MEM_PAGE_ACCESS_VIOLATION_ERROR_ID: i128 = 401i128

Any part of the list is outside the allocated memory page. See the memory convention for more details.

pub fn new(element_type: DataType) -> Self

Panics

Panics if the element has dynamic length, or if the static length is 0.

Trait Implementations

impl BasicSnippet for Pop

fn inputs(&self) -> Vec<(DataType, String)>

fn outputs(&self) -> Vec<(DataType, String)>

fn entrypoint(&self) -> String

fn code(&self, _: &mut Library) -> Vec<LabelledInstruction>

fn sign_offs(&self) -> HashMap<Reviewer, SignOffFingerprint>

Contains an entry for every sign off.

fn annotated_code(&self, library: &mut Library) -> Vec<LabelledInstruction>

fn link_for_isolated_run(&self) -> Vec<LabelledInstruction>

fn init_stack_for_isolated_run(&self) -> Vec<BFieldElement>

Initial stack on program start, when the snippet runs in isolation.

fn stack_diff(&self) -> isize

impl Clone for Pop

fn clone(&self) -> Pop

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Pop

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

Formats the value using the given formatter.

impl Hash for Pop

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Pop

fn eq(&self, other: &Pop) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Pop

impl StructuralPartialEq for Pop