Struct near_sdk::collections::Vector

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

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(id: Vec<u8>) -> Self

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

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<'a>(&'a self) -> impl Iterator<Item = Vec<u8>> + 'a

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<'a>(&'a self) -> impl Iterator<Item = T> + 'a

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> where
    u64: BorshDeserialize,
    Vec<u8>: BorshDeserialize, 

pub 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.

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

Deserialize this instance from a slice of bytes.

pub fn is_u8() -> bool

Whether Self is u8. NOTE: Vec<u8> is the most common use-case for serialization and deserialization, it's worth handling it as a special case to improve performance. It's a workaround for specific Vec<u8> implementation versus generic Vec<T> implementation. See https://github.com/rust-lang/rfcs/pull/1210 for details.

impl<T> BorshSerialize for Vector<T> where
    u64: BorshSerialize,
    Vec<u8>: BorshSerialize, 

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

pub fn try_to_vec(&self) -> Result<Vec<u8, Global>, Error>

Serialize this instance into a vector of bytes.

pub fn is_u8() -> bool

Whether Self is u8. NOTE: Vec<u8> is the most common use-case for serialization and deserialization, it's worth handling it as a special case to improve performance. It's a workaround for specific Vec<u8> implementation versus generic Vec<T> implementation. See https://github.com/rust-lang/rfcs/pull/1210 for details.

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

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

Formats the value using the given formatter.