Struct Prefix

pub struct Prefix { /* private fields */ }

A prefix prepended to each key before insertion and retrieval from the storage.

When interacting with state containers, you will usually use the same working set instance to access them, as required by the module API. This also means that you might get key collisions, so it becomes necessary to prepend a prefix to each key.

Implementations

impl Prefix

pub fn new(prefix: Vec<u8>) -> Self

Creates a new prefix from a byte vector.

pub fn as_aligned_vec(&self) -> &AlignedVec

Returns a reference to the AlignedVec containing the prefix.

pub fn len(&self) -> usize

Returns the length in bytes of the prefix.

pub fn is_empty(&self) -> bool

Returns true if the prefix is empty, false otherwise.

pub fn extended(&self, bytes: &[u8]) -> Self

Returns a new prefix allocated on the fly, by extending the current prefix with the given bytes.

Trait Implementations

impl BorshDeserialize for Prefix

where AlignedVec: BorshDeserialize,

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 BorshSerialize for Prefix

where AlignedVec: BorshSerialize,

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

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

Serialize this instance into a vector of bytes.

impl Clone for Prefix

fn clone(&self) -> Prefix

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Prefix

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Prefix

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Prefix

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

Formats the value using the given formatter.

impl Extend<u8> for Prefix

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

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl PartialEq for Prefix

fn eq(&self, other: &Prefix) -> 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 Serialize for Prefix

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Prefix

impl StructuralPartialEq for Prefix