Struct IndexInfo

pub struct IndexInfo<T: Config<I>, I: 'static = ()> {
    principal: AssetOf<T, I>,
    capital: T::Shares,
    entries: Entries<T, I>,
}

Represents an index containing multiple entries.

An IndexInfo tracks the overall capital, total balance, and the entries themselves.

Fields

principal: AssetOf<T, I>

Total asset depositted to this index

This does not qualify as real-time value of the index, since entries are finite digests that should be queried for such cases.

capital: T::Shares

Total shares/capital across all entries in this index

entries: Entries<T, I>

The collection of entries making up this index

Implementations

impl<T: Config<I>, I: 'static> IndexInfo<T, I>

pub(crate) fn new(entries: &mut Entries<T, I>) -> Result<Self, DispatchError>

Creates a new IndexInfo from a collection of entries.

This function calculates the total capital by summing the shares of all entries. It retains only entries of non-zero shares.

Returns DispatchError if any of invariant fails

• Total Capital cannot be zero
• Entries should not be empty

pub fn capital(&self) -> T::Shares

Returns the index’s capital - total shares.

pub fn principal(&self) -> AssetOf<T, I>

Returns the index’s principal, i.e. the total amount deposited by proprietors.

pub fn entries(&self) -> Vec<EntryInfo<T, I>>

Returns the index’s entries vector list.

pub fn reveal_entries(&self) -> Entries<T, I>

Reveal the actual entries Entries

pub fn entry_exists(&self, entry: &EntryDigest<T>) -> DispatchResult

Checks if an entry of digest exists in the index.

pub(crate) fn set_balance(&mut self, principal: AssetOf<T, I>)

Sets the index principal to the provided value, replacing the existing balance.

Trait Implementations

impl<T: Config<I>, I: 'static> Clone for IndexInfo<T, I>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Config<I>, I: 'static> Debug for IndexInfo<T, I>

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

Formats the value using the given formatter.

impl<T: Config<I>, I: 'static> Decode for IndexInfo<T, I>

where AssetOf<T, I>: Decode, T::Shares: Decode, Entries<T, I>: Decode,

fn decode<__CodecInputEdqy: Input>( __codec_input_edqy: &mut __CodecInputEdqy, ) -> Result<Self, Error>

Attempt to deserialise the value from input.

fn decode_into<I>( input: &mut I, dst: &mut MaybeUninit<Self>, ) -> Result<DecodeFinished, Error>

where I: Input,

Attempt to deserialize the value from input into a pre-allocated piece of memory.

fn skip<I>(input: &mut I) -> Result<(), Error>

where I: Input,

Attempt to skip the encoded value from input.

fn encoded_fixed_size() -> Option<usize>

Returns the fixed encoded size of the type.

impl<T: Config<I>, I: 'static> Encode for IndexInfo<T, I>

where AssetOf<T, I>: Encode, T::Shares: Encode, Entries<T, I>: Encode,

fn size_hint(&self) -> usize

If possible give a hint of expected size of the encoding.

fn encode_to<__CodecOutputEdqy: Output + ?Sized>( &self, __codec_dest_edqy: &mut __CodecOutputEdqy, )

Convert self to a slice and append it to the destination.

fn encode(&self) -> Vec<u8>

Convert self to an owned vector.

fn using_encoded<R, F>(&self, f: F) -> R

where F: FnOnce(&[u8]) -> R,

Convert self to a slice and then invoke the given closure with it.

fn encoded_size(&self) -> usize

Calculates the encoded size.

impl<T: Config<I>, I: 'static> MaxEncodedLen for IndexInfo<T, I>

where AssetOf<T, I>: MaxEncodedLen, T::Shares: MaxEncodedLen, Entries<T, I>: MaxEncodedLen,

fn max_encoded_len() -> usize

Upper bound, in bytes, of the maximum encoded size of this item.

impl<T: Config<I>, I: 'static> PartialEq for IndexInfo<T, I>

fn eq(&self, other: &Self) -> 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<T, I> TypeInfo for IndexInfo<T, I>

where AssetOf<T, I>: TypeInfo + 'static, T::Shares: TypeInfo + 'static, Entries<T, I>: TypeInfo + 'static, T: Config<I> + 'static, I: 'static,

type Identity = IndexInfo<T, I>

The type identifying for which type info is provided.

fn type_info() -> Type

Returns the static type identifier for Self.

impl<T: Config<I>, I: 'static> DecodeWithMemTracking for IndexInfo<T, I>

where AssetOf<T, I>: DecodeWithMemTracking, T::Shares: DecodeWithMemTracking, Entries<T, I>: DecodeWithMemTracking,

impl<T: Config<I>, I: 'static> EncodeLike for IndexInfo<T, I>

where AssetOf<T, I>: Encode, T::Shares: Encode, Entries<T, I>: Encode,

impl<T: Config<I>, I: 'static> Eq for IndexInfo<T, I>