Struct BoundedVec 

pub struct BoundedVec<T, const N: usize>
where
    T: TailCodec + Copy + Default,
{ /* private fields */ }

Bounded dynamic vector for Hopper dynamic tails.

This is the common migration target for bounded vector account metadata. Elements use TailCodec, so the vector can carry wire integers, addresses, or small custom structs declared with hopper_dynamic_tail!.

Implementations

impl<T, const N: usize> BoundedVec<T, N>

where T: TailCodec + Copy + Default,

pub fn empty() -> BoundedVec<T, N>

Construct an empty bounded vector.

pub fn from_slice(values: &[T]) -> Result<BoundedVec<T, N>, ProgramError>

Construct from a slice, rejecting values longer than N.

pub fn push(&mut self, item: T) -> Result<(), ProgramError>

Push one item into the bounded vector.

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

Pop the last initialized item, if present.

pub fn clear(&mut self)

Clear all initialized items without changing capacity.

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

Return the initialized items.

pub fn as_mut_slice(&mut self) -> &mut [T]

Return the initialized items mutably.

pub const fn len(&self) -> usize

Number of initialized items.

pub const fn capacity(&self) -> usize

Maximum number of items.

pub const fn remaining_capacity(&self) -> usize

Remaining element capacity.

pub const fn is_full(&self) -> bool

Whether the vector has reached its maximum element capacity.

pub const fn is_empty(&self) -> bool

Whether the vector is empty.

impl<T, const N: usize> BoundedVec<T, N>

where T: TailCodec + Copy + Default + PartialEq,

pub fn contains(&self, item: &T) -> bool

Return true when the initialized items contain item.

pub fn push_unique(&mut self, item: T) -> Result<bool, ProgramError>

Push item only if it is not already initialized.

Returns Ok(true) when an item was inserted and Ok(false) when it was already present.

pub fn remove_first(&mut self, item: &T) -> bool

Remove the first matching item, preserving order.

Returns true when an item was removed.

Trait Implementations

impl<T, const N: usize> Clone for BoundedVec<T, N>

where T: Clone + TailCodec + Copy + Default,

fn clone(&self) -> BoundedVec<T, N>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T, const N: usize> Default for BoundedVec<T, N>

where T: TailCodec + Copy + Default,

fn default() -> BoundedVec<T, N>

Returns the “default value” for a type.

impl<T, const N: usize> PartialEq for BoundedVec<T, N>

where T: PartialEq + TailCodec + Copy + Default,

fn eq(&self, other: &BoundedVec<T, N>) -> 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<T, const N: usize> TailCodec for BoundedVec<T, N>

where T: TailCodec + Copy + Default,

const MAX_ENCODED_LEN: usize

Upper bound on the encoded size. Used by generated helpers to verify the account has enough room before invoking encode. Implementors should pick the smallest valid bound. Hopper uses this to pre-size reallocs.

fn encode(&self, out: &mut [u8]) -> Result<usize, ProgramError>

Serialize self into out. Returns the number of bytes written (always <= MAX_ENCODED_LEN). Fails with AccountDataTooSmall when out.len() < encoded_len.

fn decode(input: &[u8]) -> Result<(BoundedVec<T, N>, usize), ProgramError>

Deserialize from input. Returns (value, bytes_consumed). Fails with InvalidAccountData on malformed encoding.

impl<T, const N: usize> Copy for BoundedVec<T, N>

where T: Copy + TailCodec + Default,

impl<T, const N: usize> Eq for BoundedVec<T, N>

where T: Eq + TailCodec + Copy + Default,

impl<T, const N: usize> StructuralPartialEq for BoundedVec<T, N>

where T: TailCodec + Copy + Default,