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 RawVals, and when retrieved from the Vec are transmitted back and converted from RawVal 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 return a Result due to this.

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);

Implementation Details

The following information is implementation details that has no consistency guarantee.

Values are stored in the environment backed by a RRB-vector using im_rc::Vector. Most operations are O(log n). Push/pop are O(1) amortised, and O(log n) in the worst case.

Struct soroban_sdk::Vec

Implementations§

impl<T> Vec<T>

pub fn env(&self) -> &Env

pub fn as_raw(&self) -> &RawVal

pub fn to_raw(&self) -> RawVal

pub fn as_object(&self) -> &VecObject

pub fn to_object(&self) -> VecObject

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

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<Result<T, T::Error>>

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

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 is_empty(&self) -> bool

pub fn len(&self) -> u32

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

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

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

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

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

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

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

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

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

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

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

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

pub fn 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,

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

pub fn iter(&self) -> VecIter<T>where T: IntoVal<Env, RawVal> + TryFromVal<Env, RawVal> + Clone,

pub fn iter_unchecked(&self) -> UncheckedIter<VecIter<T>, T, T::Error> ⓘwhere T: IntoVal<Env, RawVal> + TryFromVal<Env, RawVal> + Clone, T::Error: Debug,

pub fn into_iter_unchecked(self) -> UncheckedIter<VecIter<T>, T, T::Error> ⓘwhere T: IntoVal<Env, RawVal> + TryFromVal<Env, RawVal> + Clone, T::Error: Debug,

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

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, RawVal> + TryFromVal<Env, RawVal> + Clone,

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

Trait Implementations§

impl<T: Clone> Clone for Vec<T>

fn clone(&self) -> Vec<T>

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

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

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

impl<T> From<Vec<T>> for RawValwhere T: IntoVal<Env, RawVal> + TryFromVal<Env, RawVal>,

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

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

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

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

type Item = Result<T, <T as TryFromVal<Env, RawVal>>::Error>

type IntoIter = VecIter<T>

fn into_iter(self) -> Self::IntoIter

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

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<Self>,

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

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

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

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

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

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

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

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

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

impl<T> TryFrom<&Vec<T>> for ScVal

type Error = ConversionError

fn try_from(v: &Vec<T>) -> Result<Self, Self::Error>

impl<T> TryFrom<&Vec<T>> for ScVec

type Error = ConversionError