Struct soroban_env_host::MeteredOrdMap

pub struct MeteredOrdMap<K, V, Ctx>where
    K: MeteredClone,
    V: MeteredClone,
    Ctx: AsBudget + Compare<K, Error = HostError> + Compare<V, Error = HostError>,{ /* private fields */ }

Implementations

impl<K, V, Ctx> MeteredOrdMap<K, V, Ctx>where
    K: MeteredClone,
    V: MeteredClone,
    Ctx: AsBudget + Compare<K, Error = HostError> + Compare<V, Error = HostError>,

pub fn new(ctx: &Ctx) -> Result<Self, HostError>

pub fn from_map(map: Vec<(K, V)>, ctx: &Ctx) -> Result<Self, HostError>

pub fn from_exact_iter<I: Iterator<Item = (K, V)>>(
    iter: I,
    ctx: &Ctx
) -> Result<Self, HostError>

pub fn insert(&self, key: K, value: V, ctx: &Ctx) -> Result<Self, HostError>

pub fn get<Q>(&self, key: &Q, ctx: &Ctx) -> Result<Option<&V>, HostError>where
    K: Borrow<Q>,
    Ctx: Compare<Q, Error = HostError>,

pub fn remove<Q>(
    &self,
    key: &Q,
    ctx: &Ctx
) -> Result<Option<(Self, V)>, HostError>where
    K: Borrow<Q>,
    Ctx: Compare<Q, Error = HostError>,

Returns a Some((new_self, val)) pair where new_self no longer contains an entry for key, if the key existed, otherwise None if key didn’t exist (in which case there’s no need to clone).

pub fn len(&self) -> usize

pub fn contains_key<Q>(&self, key: &Q, ctx: &Ctx) -> Result<bool, HostError>where
    K: Borrow<Q>,
    Ctx: Compare<Q, Error = HostError>,

pub fn get_prev<Q>(
    &self,
    key: &Q,
    ctx: &Ctx
) -> Result<Option<&(K, V)>, HostError>where
    K: Borrow<Q>,
    Ctx: Compare<Q, Error = HostError>,

pub fn get_next<Q>(
    &self,
    key: &Q,
    ctx: &Ctx
) -> Result<Option<&(K, V)>, HostError>where
    K: Borrow<Q>,
    Ctx: Compare<Q, Error = HostError>,

pub fn get_min<Q>(&self, ctx: &Ctx) -> Result<Option<&(K, V)>, HostError>where
    K: Borrow<Q>,
    Ctx: Compare<Q, Error = HostError>,

pub fn get_max<Q>(&self, ctx: &Ctx) -> Result<Option<&(K, V)>, HostError>where
    K: Borrow<Q>,
    Ctx: Compare<Q, Error = HostError>,

pub fn keys(&self, ctx: &Ctx) -> Result<impl Iterator<Item = &K>, HostError>

pub fn values(&self, ctx: &Ctx) -> Result<impl Iterator<Item = &V>, HostError>

pub fn iter(&self, ctx: &Ctx) -> Result<impl Iterator<Item = &(K, V)>, HostError>

Trait Implementations

impl<K, V, Ctx> Clone for MeteredOrdMap<K, V, Ctx>where
    K: MeteredClone,
    V: MeteredClone,
    Ctx: AsBudget + Compare<K, Error = HostError> + Compare<V, Error = HostError>,

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<K, V> Compare<MeteredOrdMap<K, V, Budget>> for Budgetwhere
    K: MeteredClone,
    V: MeteredClone,
    Budget: Compare<K, Error = HostError> + Compare<V, Error = HostError>,

type Error = HostError

fn compare(
    &self,
    a: &MeteredOrdMap<K, V, Budget>,
    b: &MeteredOrdMap<K, V, Budget>
) -> Result<Ordering, Self::Error>

impl<K, V> Compare<MeteredOrdMap<K, V, Host>> for Hostwhere
    K: MeteredClone,
    V: MeteredClone,
    Host: Compare<K, Error = HostError> + Compare<V, Error = HostError>,

type Error = HostError

fn compare(
    &self,
    a: &MeteredOrdMap<K, V, Host>,
    b: &MeteredOrdMap<K, V, Host>
) -> Result<Ordering, Self::Error>

impl<K, V, Ctx> Default for MeteredOrdMap<K, V, Ctx>where
    K: MeteredClone,
    V: MeteredClone,
    Ctx: AsBudget + Compare<K, Error = HostError> + Compare<V, Error = HostError>,

fn default() -> Self

Returns the “default value” for a type.

impl<'a, K, V, Ctx> IntoIterator for &'a MeteredOrdMap<K, V, Ctx>where
    K: MeteredClone,
    V: MeteredClone,
    Ctx: AsBudget + Compare<K, Error = HostError> + Compare<V, Error = HostError>,

type Item = &'a (K, V)

The type of the elements being iterated over.

type IntoIter = Iter<'a, (K, V)>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<K, V, Ctx> IntoIterator for MeteredOrdMap<K, V, Ctx>where
    K: MeteredClone,
    V: MeteredClone,
    Ctx: AsBudget + Compare<K, Error = HostError> + Compare<V, Error = HostError>,

type Item = (K, V)

The type of the elements being iterated over.

type IntoIter = IntoIter<(K, V), Global>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.