Struct soroban_sdk::Vec

source ·

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

Expand description

Vec is a sequential and indexable growable collection type.

Values are stored in the environment and are available to contract through the functions defined on Vec. Values stored in the Vec are transmitted to the environment as Vals, and when retrieved from the Vec are transmitted back and converted from Val back into their type.

The values in a Vec are not guaranteed to be of type T and conversion will fail if they are not. Most functions on Vec have a try_ variation that returns a Result that will be Err if the conversion fails. Functions that are not prefixed with try_ will panic if conversion fails.

There are some cases where this lack of guarantee is important:

When storing a Vec that has been provided externally as a contract function argument, be aware there is no guarantee that all items in the Vec will be of type T. It may be necessary to validate all values, either before storing, or when loading with try_ variation functions.
When accessing and iterating over a Vec that has been provided externally as a contract function input, and the contract needs to be resilient to failure, use the try_ variation functions.

Functions with an _unchecked suffix will panic if called with indexes that are out-of-bounds.

To store u8s and binary data, use Bytes/BytesN instead.

Vec values can be stored as Storage, or in other types like Vec, Map, etc.

Examples

use soroban_sdk::{vec, Env};

let env = Env::default();
let vec = vec![&env, 0, 1, 2, 3];
assert_eq!(vec.len(), 4);

Struct soroban_sdk::Vec

Implementations§

impl<T> Vec<T>

pub fn env(&self) -> &Env

pub fn as_val(&self) -> &Val

pub fn to_val(&self) -> Val

pub fn as_object(&self) -> &VecObject

pub fn to_object(&self) -> VecObject

pub fn to_vals(&self) -> Vec<Val>

impl<T> Vec<T>where T: IntoVal<Env, Val> + TryFromVal<Env, Val>,

pub fn new(env: &Env) -> Vec<T>

pub fn from_array<const N: usize>(env: &Env, items: [T; N]) -> Vec<T>

pub fn from_slice(env: &Env, items: &[T]) -> Vec<T>where T: Clone,

pub fn get(&self, i: u32) -> Option<T>

pub fn try_get(&self, i: u32) -> Result<Option<T>, T::Error>

pub fn get_unchecked(&self, i: u32) -> T

pub fn try_get_unchecked(&self, i: u32) -> Result<T, T::Error>

pub fn set(&mut self, i: u32, v: T)

pub fn remove(&mut self, i: u32) -> Option<()>

pub fn remove_unchecked(&mut self, i: u32)

pub fn push_front(&mut self, x: T)

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

pub fn try_pop_front(&mut self) -> Result<Option<T>, T::Error>

pub fn pop_front_unchecked(&mut self) -> T

pub fn try_pop_front_unchecked(&mut self) -> Result<T, T::Error>

pub fn push_back(&mut self, x: T)

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

pub fn try_pop_back(&mut self) -> Result<Option<T>, T::Error>

pub fn pop_back_unchecked(&mut self) -> T

pub fn try_pop_back_unchecked(&mut self) -> Result<T, T::Error>

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

pub fn try_first(&self) -> Result<Option<T>, T::Error>

pub fn first_unchecked(&self) -> T

pub fn try_first_unchecked(&self) -> Result<T, T::Error>

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

pub fn try_last(&self) -> Result<Option<T>, T::Error>

pub fn last_unchecked(&self) -> T

pub fn try_last_unchecked(&self) -> Result<T, T::Error>

pub fn insert(&mut self, i: u32, x: T)

pub fn append(&mut self, other: &Vec<T>)

pub fn extend_from_array<const N: usize>(&mut self, items: [T; N])

pub fn extend_from_slice(&mut self, items: &[T])where T: Clone,

impl<T> Vec<T>

pub fn slice(&self, r: impl RangeBounds<u32>) -> Self

pub fn shuffle(&mut self)

pub fn to_shuffled(&self) -> Self

pub fn is_empty(&self) -> bool

pub fn len(&self) -> u32

impl<T> Vec<T>where T: IntoVal<Env, Val>,

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

pub fn first_index_of(&self, item: impl Borrow<T>) -> Option<u32>

pub fn last_index_of(&self, item: impl Borrow<T>) -> Option<u32>

pub fn binary_search(&self, item: impl Borrow<T>) -> Result<u32, u32>

impl<T> Vec<Vec<T>>where T: IntoVal<Env, Val> + TryFromVal<Env, Val> + Clone,

pub fn concat(&self) -> Vec<T>

impl<T> Vec<T>where T: IntoVal<Env, Val> + TryFromVal<Env, Val>,

pub fn iter(&self) -> UnwrappedIter<VecTryIter<T>, T, T::Error> ⓘwhere T: IntoVal<Env, Val> + TryFromVal<Env, Val> + Clone, T::Error: Debug,

pub fn try_iter(&self) -> VecTryIter<T>where T: IntoVal<Env, Val> + TryFromVal<Env, Val> + Clone,

pub fn into_try_iter(self) -> VecTryIter<T>where T: IntoVal<Env, Val> + TryFromVal<Env, Val> + Clone, T::Error: Debug,

Trait Implementations§

impl<T> Clone for Vec<T>

fn clone(&self) -> Self

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

impl<T> Debug for Vec<T>where T: IntoVal<Env, Val> + TryFromVal<Env, Val> + Debug + Clone, T::Error: Debug,

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

impl<T> From<Vec<T>> for Valwhere T: IntoVal<Env, Val> + TryFromVal<Env, Val>,

fn from(v: Vec<T>) -> Self

impl<T> From<Vec<T>> for VecObjectwhere T: IntoVal<Env, Val> + TryFromVal<Env, Val>,

fn from(v: Vec<T>) -> Self

impl<T> IntoIterator for Vec<T>where T: IntoVal<Env, Val> + TryFromVal<Env, Val>,

type Item = T

type IntoIter = UnwrappedIter<VecTryIter<T>, T, <T as TryFromVal<Env, Val>>::Error>

fn into_iter(self) -> Self::IntoIter

impl<T> Ord for Vec<T>where T: IntoVal<Env, Val> + TryFromVal<Env, Val>,

fn cmp(&self, other: &Self) -> Ordering

fn max(self, other: Self) -> Selfwhere Self: Sized,

fn min(self, other: Self) -> Selfwhere Self: Sized,

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd,

impl<T> PartialEq for Vec<T>where T: IntoVal<Env, Val> + TryFromVal<Env, Val>,

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

impl<T> Vec<T>
where T: IntoVal<Env, Val> + TryFromVal<Env, Val>,

pub fn from_slice(env: &Env, items: &[T]) -> Vec<T>
where T: Clone,

pub fn extend_from_slice(&mut self, items: &[T])
where T: Clone,

impl<T> Vec<T>
where T: IntoVal<Env, Val>,

impl<T> Vec<Vec<T>>
where T: IntoVal<Env, Val> + TryFromVal<Env, Val> + Clone,

impl<T> Vec<T>
where T: IntoVal<Env, Val> + TryFromVal<Env, Val>,

pub fn iter(&self) -> UnwrappedIter<VecTryIter<T>, T, T::Error> ⓘ
where T: IntoVal<Env, Val> + TryFromVal<Env, Val> + Clone, T::Error: Debug,

pub fn try_iter(&self) -> VecTryIter<T>
where T: IntoVal<Env, Val> + TryFromVal<Env, Val> + Clone,

pub fn into_try_iter(self) -> VecTryIter<T>
where T: IntoVal<Env, Val> + TryFromVal<Env, Val> + Clone, T::Error: Debug,

impl<T> Debug for Vec<T>
where T: IntoVal<Env, Val> + TryFromVal<Env, Val> + Debug + Clone, T::Error: Debug,

impl<T> From<Vec<T>> for Val
where T: IntoVal<Env, Val> + TryFromVal<Env, Val>,

impl<T> From<Vec<T>> for VecObject
where T: IntoVal<Env, Val> + TryFromVal<Env, Val>,

impl<T> IntoIterator for Vec<T>
where T: IntoVal<Env, Val> + TryFromVal<Env, Val>,

impl<T> Ord for Vec<T>
where T: IntoVal<Env, Val> + TryFromVal<Env, Val>,

fn max(self, other: Self) -> Self
where Self: Sized,

fn min(self, other: Self) -> Self
where Self: Sized,

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized + PartialOrd,

impl<T> PartialEq for Vec<T>
where T: IntoVal<Env, Val> + TryFromVal<Env, Val>,

impl<T> PartialOrd for Vec<T>
where T: IntoVal<Env, Val> + TryFromVal<Env, Val>,

impl<T> SorobanArbitrary for Vec<T>
where T: SorobanArbitrary,