Struct sov_state::StateValue

pub struct StateValue<V, Codec = BorshCodec> { /* private fields */ }

Container for a single value.

Implementations

impl<V> StateValue<V>

pub fn new(prefix: Prefix) -> Self

Crates a new StateValue with the given prefix and the default StateValueCodec (i.e. BorshCodec).

impl<V, Codec> StateValue<V, Codec>

pub fn with_codec(prefix: Prefix, codec: Codec) -> Self

Creates a new StateValue with the given prefix and codec.

pub fn prefix(&self) -> &Prefix

Returns the prefix used when this StateValue was created.

impl<V, Codec> StateValue<V, Codec>where Codec: StateCodec, Codec::ValueCodec: StateValueCodec<V>,

pub fn set<S: Storage>(&self, value: &V, working_set: &mut WorkingSet<S>)

Sets a value in the StateValue.

pub fn get<S: Storage>(&self, working_set: &mut WorkingSet<S>) -> Option<V>

Gets a value from the StateValue or None if the value is absent.

pub fn get_or_err<S: Storage>( &self, working_set: &mut WorkingSet<S> ) -> Result<V, Error>

Gets a value from the StateValue or Error if the value is absent.

pub fn remove<S: Storage>(&self, working_set: &mut WorkingSet<S>) -> Option<V>

Removes a value from the StateValue, returning the value (or None if the key is absent).

pub fn remove_or_err<S: Storage>( &self, working_set: &mut WorkingSet<S> ) -> Result<V, Error>

Removes a value and from the StateValue, returning the value (or Error if the key is absent).

pub fn delete<S: Storage>(&self, working_set: &mut WorkingSet<S>)

Deletes a value from the StateValue.

Trait Implementations

impl<V, Codec> BorshDeserialize for StateValue<V, Codec>where PhantomData<V>: BorshDeserialize, Codec: BorshDeserialize, Prefix: 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<V, Codec> BorshSerialize for StateValue<V, Codec>where PhantomData<V>: BorshSerialize, Codec: BorshSerialize, Prefix: BorshSerialize,

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

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

Serialize this instance into a vector of bytes.

impl<V: Clone, Codec: Clone> Clone for StateValue<V, Codec>

fn clone(&self) -> StateValue<V, Codec>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<V: Debug, Codec: Debug> Debug for StateValue<V, Codec>

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

Formats the value using the given formatter.

impl<'de, V, Codec> Deserialize<'de> for StateValue<V, Codec>where Codec: Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<V: PartialEq, Codec: PartialEq> PartialEq<StateValue<V, Codec>> for StateValue<V, Codec>

fn eq(&self, other: &StateValue<V, Codec>) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<V, Codec> Serialize for StateValue<V, Codec>where Codec: Serialize,

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

Serialize this value into the given Serde serializer.

impl<V, Codec> StructuralPartialEq for StateValue<V, Codec>