Struct Vector

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

An iterable implementation of vector that stores its content on the trie. Uses the following map: index -> element.

Implementations

impl<T> Vector<T>

pub fn len(&self) -> u64

Returns the number of elements in the vector, also referred to as its size.

pub fn is_empty(&self) -> bool

Returns true if the vector contains no elements.

pub fn new<S>(prefix: S) -> Self

where S: IntoStorageKey,

Create new vector with zero elements. Use id as a unique identifier on the trie.

Examples

use near_sdk::collections::Vector;
let mut set: Vector<u32> = Vector::new(b"m");

pub fn to_v2(&self) -> Vector<T>

where T: BorshSerialize,

Helper utility to be able to easily migrate to the new Vector implementation.

This new Vector’s API matches the Rust Vec API more closely and has a caching layer to avoid reading/writing redundant times to storage.

pub fn get_raw(&self, index: u64) -> Option<Vec<u8>>

Returns the serialized element by index or None if it is not present.

pub fn swap_remove_raw(&mut self, index: u64) -> Vec<u8>

Removes an element from the vector and returns it in serialized form. The removed element is replaced by the last element of the vector. Does not preserve ordering, but is O(1).

Panics

Panics if index is out of bounds.

pub fn push_raw(&mut self, raw_element: &[u8])

Appends a serialized element to the back of the collection.

pub fn pop_raw(&mut self) -> Option<Vec<u8>>

Removes the last element from a vector and returns it without deserializing, or None if it is empty.

pub fn replace_raw(&mut self, index: u64, raw_element: &[u8]) -> Vec<u8>

Inserts a serialized element at index, returns a serialized evicted element.

Panics

If index is out of bounds.

pub fn iter_raw(&self) -> RawIter<'_, T>

Iterate over raw serialized elements.

pub fn extend_raw<IT: IntoIterator<Item = Vec<u8>>>(&mut self, iter: IT)

Extends vector from the given collection of serialized elements.

impl<T> Vector<T>

pub fn clear(&mut self)

Removes all elements from the collection.

impl<T> Vector<T>

where T: BorshSerialize,

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

Appends an element to the back of the collection.

pub fn extend<IT: IntoIterator<Item = T>>(&mut self, iter: IT)

Extends vector from the given collection.

impl<T> Vector<T>

where T: BorshDeserialize,

pub fn get(&self, index: u64) -> Option<T>

Returns the element by index or None if it is not present.

pub fn swap_remove(&mut self, index: u64) -> T

Removes an element from the vector and returns it. The removed element is replaced by the last element of the vector. Does not preserve ordering, but is O(1).

Panics

Panics if index is out of bounds.

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

Removes the last element from a vector and returns it, or None if it is empty.

pub fn iter(&self) -> Iter<'_, T>

Iterate over deserialized elements.

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

impl<T> Vector<T>

where T: BorshSerialize + BorshDeserialize,

pub fn replace(&mut self, index: u64, element: &T) -> T

Inserts a element at index, returns an evicted element.

Panics

If index is out of bounds.

Trait Implementations

impl<T> BorshDeserialize for Vector<T>

fn deserialize_reader<__R: Read>(reader: &mut __R) -> Result<Self, Error>

fn deserialize(buf: &mut &[u8]) -> Result<Self, Error>

Deserializes this instance from a given slice of bytes. Updates the buffer to point at the remaining bytes.

fn try_from_slice(v: &[u8]) -> Result<Self, Error>

Deserialize this instance from a slice of bytes.

fn try_from_reader<R>(reader: &mut R) -> Result<Self, Error>

where R: Read,

impl<T> BorshSchema for Vector<T>

fn declaration() -> Declaration

Get the name of the type without brackets.

fn add_definitions_recursively( definitions: &mut BTreeMap<Declaration, Definition>, )

Recursively, using DFS, add type definitions required for this type. Type definition partially explains how to serialize/deserialize a type.

impl<T> BorshSerialize for Vector<T>

fn serialize<__W: Write>(&self, writer: &mut __W) -> Result<(), Error>

impl<T: Debug + BorshDeserialize> Debug for Vector<T>

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

Formats the value using the given formatter.