Struct Annotations

pub struct Annotations(/* private fields */);

Methods from Deref<Target = TinyOrdMap<AnnotationName, SmallBlob>>

pub fn iter_mut(&'c mut self) -> <&'c mut C as IntoIterator>::IntoIter

Returns an iterator that allows modifying each value.

The iterator yields all items from start to end.

pub fn values_mut( &mut self, ) -> impl Iterator<Item = &mut <C as KeyedCollection>::Value>

Returns an iterator that allows modifying each value for each key.

pub fn keyed_values_mut( &mut self, ) -> impl Iterator<Item = (&<C as KeyedCollection>::Key, &mut <C as KeyedCollection>::Value)>

Returns an iterator that allows modifying each value for each key.

pub fn as_inner(&self) -> &C

👎Deprecated since 4.7.0: use as_unconfined method

Returns inner collection type

pub fn as_unconfined(&self) -> &C

Returns reference to the inner collection type.

pub fn to_inner(&self) -> C

where C: Clone,

👎Deprecated since 4.7.0: use to_unconfined method

Clones inner collection type and returns it

pub fn to_unconfined(&self) -> C

where C: Clone,

Clones inner collection and returns an unconfined version of it.

pub fn push(&mut self, elem: <C as Collection>::Item) -> Result<(), Error>

Attempts to add a single element to the confined collection. Fails if the number of elements in the collection already maximal.

pub fn extend<T>(&mut self, iter: T) -> Result<(), Error>

where T: IntoIterator<Item = <C as Collection>::Item>,

Attempts to add all elements from an iterator to the confined collection. Fails if the number of elements in the collection already maximal.

pub fn clear(&mut self)

Removes all elements from the confined collection.

pub fn len_u8(&self) -> u8

Returns number of elements in the confined collection as u8. The confinement guarantees that the collection length can’t exceed u8::MAX.

pub fn len_u16(&self) -> u16

Returns number of elements in the confined collection as u16. The confinement guarantees that the collection length can’t exceed u16::MAX.

pub fn len_u24(&self) -> u24

Returns number of elements in the confined collection as u24. The confinement guarantees that the collection length can’t exceed u24::MAX.

pub fn len_u32(&self) -> u32

Returns number of elements in the confined collection as u32. The confinement guarantees that the collection length can’t exceed u32::MAX.

pub fn get_mut( &mut self, key: &<C as KeyedCollection>::Key, ) -> Option<&mut <C as KeyedCollection>::Value>

Gets mutable reference to an element of the collection.

pub fn insert( &mut self, key: <C as KeyedCollection>::Key, value: <C as KeyedCollection>::Value, ) -> Result<Option<<C as KeyedCollection>::Value>, Error>

Inserts a new value into the confined collection under a given key. Fails if the collection already contains maximum number of elements allowed by the confinement.

pub fn entry( &mut self, key: <C as KeyedCollection>::Key, ) -> Result<<C as KeyedCollection>::Entry<'_>, Error>

Gets the given key’s corresponding entry in the map for in-place manipulation. Errors if the collection entry is vacant and the collection has already reached maximal size of its confinement.

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

Removes the last character from a string and returns it, or None if it is empty.

pub fn remove(&mut self, index: usize) -> Result<char, Error>

Removes a single character from the confined string, unless the string doesn’t shorten more than the confinement requirement. Errors otherwise.

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

Removes the last character from a string and returns it, or None if it is empty.

pub fn remove(&mut self, index: usize) -> Result<AsciiChar, Error>

Removes a single character from the confined string, unless the string doesn’t shorten more than the confinement requirement. Errors otherwise.

pub fn as_slice(&self) -> &[T]

Returns slice representation of the vec.

pub fn get_mut<I>( &mut self, index: I, ) -> Option<&mut <I as SliceIndex<[T]>>::Output>

where I: SliceIndex<[T]>,

Gets the mutable element of a vector

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 remove(&mut self, index: usize) -> Result<T, Error>

Removes an element from the vector at a given index. Errors if the index exceeds the number of elements in the vector, of if the new vector length will be less than the confinement requirement. Returns the removed element otherwise.

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

Returns an iterator over the slice.

The iterator yields all items from start to end.

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

Removes the first element and returns it, or None if the deque is empty.

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

Removes the last element and returns it, or None if the deque is empty.

pub fn push_front(&mut self, elem: T) -> Result<(), Error>

Prepends an element to the deque. Errors if the new collection length will not fit the confinement requirements.

pub fn push_from(&mut self, elem: T) -> Result<(), Error>

👎Deprecated since 4.7.1: use push_front

pub fn push_back(&mut self, elem: T) -> Result<(), Error>

Appends an element to the deque. Errors if the new collection length will not fit the confinement requirements.

pub fn remove(&mut self, index: usize) -> Result<T, Error>

Removes an element from the deque at a given index. Errors if the index exceeds the number of elements in the deque, of if the new deque length will be less than the confinement requirement. Returns the removed element otherwise.

pub fn drain<R>(&mut self, range: R) -> Drain<'_, T>

where R: RangeBounds<usize>,

Removes the specified range from the deque in bulk, returning all removed elements as an iterator. If the iterator is dropped before being fully consumed, it drops the remaining removed elements.

The returned iterator keeps a mutable borrow on the queue to optimize its implementation.

Panics

Panics if the starting point is greater than the end point or if the end point is greater than the length of the deque.

Leaking

If the returned iterator goes out of scope without being dropped (due to [mem::forget], for example), the deque may have lost and leaked elements arbitrarily, including elements outside the range.

pub fn truncate(&mut self, len: usize)

Shortens the deque, keeping the first len elements and dropping the rest.

If len is greater or equal to the deque’s current length, this has no effect.

pub fn remove(&mut self, elem: &T) -> Result<bool, Error>

Removes an element from the set. Errors if the index exceeds the number of elements in the set, of if the new collection length will be less than the confinement requirement. Returns if the element was present in the set.

pub fn take(&mut self, elem: &T) -> Result<Option<T>, Error>

Removes an element from the set. Errors if the index exceeds the number of elements in the set, of if the new collection length will be less than the confinement requirement. Returns the removed element otherwise.

pub fn remove(&mut self, elem: &T) -> Result<bool, Error>

Removes an element from the set. Errors if the index exceeds the number of elements in the set, of if the new collection length will be less than the confinement requirement. Returns if the element was present in the set.

pub fn take(&mut self, elem: &T) -> Result<Option<T>, Error>

Removes an element from the set. Errors if the index exceeds the number of elements in the set, of if the new collection length will be less than the confinement requirement. Returns the removed element otherwise.

pub fn remove(&mut self, key: &K) -> Result<Option<V>, Error>

Removes an element from the map. Errors if the index exceeds the number of elements in the map, of if the new collection length will be less than the confinement requirement. Returns the removed value otherwise.

pub fn remove(&mut self, key: &K) -> Result<Option<V>, Error>

Removes an element from the map. Errors if the index exceeds the number of elements in the map, of if the new collection length will be less than the confinement requirement. Returns the removed value otherwise.

Trait Implementations

impl AsMut<<Annotations as Wrapper>::Inner> for Annotations

fn as_mut(&mut self) -> &mut <Self as Wrapper>::Inner

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsRef<Confined<BTreeMap<AnnotationName, Confined<Vec<u8>, amplify::::collection::confinement::SmallBlob::{constant#0}, amplify::::collection::confinement::SmallBlob::{constant#1}>>, amplify::::collection::confinement::TinyOrdMap::{constant#0}, amplify::::collection::confinement::TinyOrdMap::{constant#1}>> for Annotations

fn as_ref(&self) -> &TinyOrdMap<AnnotationName, SmallBlob>

Converts this type into a shared reference of the (usually inferred) input type.

impl Borrow<Confined<BTreeMap<AnnotationName, Confined<Vec<u8>, amplify::::collection::confinement::SmallBlob::{constant#0}, amplify::::collection::confinement::SmallBlob::{constant#1}>>, amplify::::collection::confinement::TinyOrdMap::{constant#0}, amplify::::collection::confinement::TinyOrdMap::{constant#1}>> for Annotations

fn borrow(&self) -> &TinyOrdMap<AnnotationName, SmallBlob>

Immutably borrows from an owned value.

impl BorrowMut<<Annotations as Wrapper>::Inner> for Annotations

fn borrow_mut(&mut self) -> &mut <Self as Wrapper>::Inner

Mutably borrows from an owned value.

impl Clone for Annotations

fn clone(&self) -> Annotations

Returns a copy of the value.

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

Performs copy-assignment from source.

impl CommitEncode for Annotations

type CommitmentId = StrictHash

Type of the resulting commitment.

fn commit_encode(&self, engine: &mut CommitEngine)

Encodes the data for the commitment by writing them directly into a std::io::Write writer instance

impl Debug for Annotations

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

Formats the value using the given formatter.

impl Default for Annotations

fn default() -> Annotations

Returns the “default value” for a type.

impl Deref for Annotations

type Target = Confined<BTreeMap<AnnotationName, Confined<Vec<u8>, amplify::::collection::confinement::SmallBlob::{constant#0}, amplify::::collection::confinement::SmallBlob::{constant#1}>>, amplify::::collection::confinement::TinyOrdMap::{constant#0}, amplify::::collection::confinement::TinyOrdMap::{constant#1}>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for Annotations

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<'de> Deserialize<'de> for Annotations

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<Annotations> for TinyOrdMap<AnnotationName, SmallBlob>

fn from(wrapped: Annotations) -> Self

Converts to this type from the input type.

impl From<Confined<BTreeMap<AnnotationName, Confined<Vec<u8>, amplify::::collection::confinement::SmallBlob::{constant#0}, amplify::::collection::confinement::SmallBlob::{constant#1}>>, amplify::::collection::confinement::TinyOrdMap::{constant#0}, amplify::::collection::confinement::TinyOrdMap::{constant#1}>> for Annotations

fn from(v: TinyOrdMap<AnnotationName, SmallBlob>) -> Self

Converts to this type from the input type.

impl Hash for Annotations

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Annotations

fn cmp(&self, other: &Annotations) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Annotations

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

fn partial_cmp(&self, other: &Annotations) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for Annotations

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StrictDecode for Annotations

fn strict_decode(reader: &mut impl TypedRead) -> Result<Self, DecodeError>

fn strict_read(reader: impl ReadRaw) -> Result<Self, DecodeError>

impl StrictEncode for Annotations

fn strict_encode<W: TypedWrite>(&self, writer: W) -> Result<W>

fn strict_write(&self, writer: impl WriteRaw) -> Result<(), Error>

impl StrictTuple for Annotations

const FIELD_COUNT: u8 = 1u8

fn strict_check_fields()

fn strict_type_info() -> TypeInfo<Self>

impl StrictType for Annotations

const STRICT_LIB_NAME: &'static str = LIB_NAME_SONIC

fn strict_name() -> Option<TypeName>

impl Wrapper for Annotations

type Inner = Confined<BTreeMap<AnnotationName, Confined<Vec<u8>, amplify::::collection::confinement::SmallBlob::{constant#0}, amplify::::collection::confinement::SmallBlob::{constant#1}>>, amplify::::collection::confinement::TinyOrdMap::{constant#0}, amplify::::collection::confinement::TinyOrdMap::{constant#1}>

Inner type wrapped by the current newtype

fn from_inner(inner: Self::Inner) -> Self

Instantiates wrapper type with the inner data

fn as_inner(&self) -> &Self::Inner

Returns reference to the inner representation for the wrapper type

fn into_inner(self) -> Self::Inner

Unwraps the wrapper returning the inner type

fn to_inner(&self) -> Self::Inner

where Self::Inner: Clone,

Clones inner data of the wrapped type and return them

fn copy(&self) -> Self

where Self: Sized, Self::Inner: Copy,

Copies the wrapped type

impl WrapperMut for Annotations

fn as_inner_mut(&mut self) -> &mut <Self as Wrapper>::Inner

Returns a mutable reference to the inner representation for the wrapper type

impl Eq for Annotations

impl StrictProduct for Annotations

impl StructuralPartialEq for Annotations