fuel_core_storage::blueprint::sparse

Struct Sparse

Source 
pub struct Sparse<KeyCodec, ValueCodec, Metadata, Nodes, KeyConverter> { /* private fields */ }
Expand description

The Sparse blueprint builds the storage as a Plain blueprint and maintains the sparse merkle tree by the Metadata and Nodes tables.

It uses the KeyCodec and ValueCodec to encode/decode the key and value in the same way as a plain blueprint.

The Metadata table stores the metadata of the tree(like a root of the tree), and the Nodes table stores the tree’s nodes. The SMT is built over the encoded keys and values using the same encoding as for main key-value pairs.

The KeyConverter is used to convert the key of the table into the primary key of the metadata table.

Trait Implementations§

Source§

impl<M, S, KeyCodec, ValueCodec, Metadata, Nodes, KeyConverter> BlueprintInspect<M, S> for Sparse<KeyCodec, ValueCodec, Metadata, Nodes, KeyConverter>
where M: Mappable, S: KeyValueInspect, KeyCodec: Encode<M::Key> + Decode<M::OwnedKey>, ValueCodec: Encode<M::Value> + Decode<M::OwnedValue>,

Source§

type KeyCodec = KeyCodec

The codec used to encode and decode storage key.
Source§

type ValueCodec = ValueCodec

The codec used to encode and decode storage value.
Source§

fn exists(storage: &S, key: &M::Key, column: S::Column) -> StorageResult<bool>

Checks if the value exists in the storage.
Source§

fn size_of_value( storage: &S, key: &M::Key, column: S::Column, ) -> StorageResult<Option<usize>>

Returns the size of the value in the storage.
Source§

fn get( storage: &S, key: &M::Key, column: S::Column, ) -> StorageResult<Option<M::OwnedValue>>

Returns the value from the storage.
Source§

impl<M, S, KeyCodec, ValueCodec, Metadata, Nodes, KeyConverter> BlueprintMutate<M, S> for Sparse<KeyCodec, ValueCodec, Metadata, Nodes, KeyConverter>
where M: Mappable, S: KeyValueMutate + StorageMutate<Metadata, Error = Error> + StorageMutate<Nodes, Error = Error>, KeyCodec: Encode<M::Key> + Decode<M::OwnedKey>, ValueCodec: Encode<M::Value> + Decode<M::OwnedValue>, Metadata: Mappable<Value = SparseMerkleMetadata, OwnedValue = SparseMerkleMetadata>, Nodes: Mappable<Key = MerkleRoot, Value = Primitive, OwnedValue = Primitive>, KeyConverter: PrimaryKey<InputKey = M::Key, OutputKey = Metadata::Key>,

Source§

fn put( storage: &mut S, key: &M::Key, column: S::Column, value: &M::Value, ) -> StorageResult<()>

Puts the key-value pair into the storage.
Source§

fn replace( storage: &mut S, key: &M::Key, column: S::Column, value: &M::Value, ) -> StorageResult<Option<M::OwnedValue>>

Puts the key-value pair into the storage and returns the old value.
Source§

fn take( storage: &mut S, key: &M::Key, column: S::Column, ) -> StorageResult<Option<M::OwnedValue>>

Takes the value from the storage and returns it. The value is removed from the storage.
Source§

fn delete(storage: &mut S, key: &M::Key, column: S::Column) -> StorageResult<()>

Removes the value from the storage.
Source§

impl<Column, M, S, KeyCodec, ValueCodec, Metadata, Nodes, KeyConverter> SupportsBatching<M, S> for Sparse<KeyCodec, ValueCodec, Metadata, Nodes, KeyConverter>
where Column: StorageColumn, S: BatchOperations<Column = Column> + StorageMutate<M, Error = Error> + StorageMutate<Metadata, Error = Error> + StorageMutate<Nodes, Error = Error>, M: TableWithBlueprint<Blueprint = Sparse<KeyCodec, ValueCodec, Metadata, Nodes, KeyConverter>, Column = Column>, KeyCodec: Encode<M::Key> + Decode<M::OwnedKey>, ValueCodec: Encode<M::Value> + Decode<M::OwnedValue>, Metadata: Mappable<Value = SparseMerkleMetadata, OwnedValue = SparseMerkleMetadata>, Nodes: Mappable<Key = MerkleRoot, Value = Primitive, OwnedValue = Primitive> + TableWithBlueprint<Column = Column>, KeyConverter: PrimaryKey<InputKey = M::Key, OutputKey = Metadata::Key>, Nodes::Blueprint: BlueprintInspect<Nodes, S>,

Source§

fn init<'a, Iter>( storage: &mut S, column: S::Column, set: Iter, ) -> StorageResult<()>
where Iter: 'a + Iterator<Item = (&'a M::Key, &'a M::Value)>, M::Key: 'a, M::Value: 'a,

Initializes the storage with a bunch of key-value pairs. In some cases, this method may be more performant than Self::insert.
Source§

fn insert<'a, Iter>( storage: &mut S, column: S::Column, set: Iter, ) -> StorageResult<()>
where Iter: 'a + Iterator<Item = (&'a M::Key, &'a M::Value)>, M::Key: 'a, M::Value: 'a,

Inserts the batch of key-value pairs into the storage.
Source§

fn remove<'a, Iter>( storage: &mut S, column: S::Column, set: Iter, ) -> StorageResult<()>
where Iter: 'a + Iterator<Item = &'a M::Key>, M::Key: 'a,

Removes the batch of key-value pairs from the storage.
Source§

impl<M, S, KeyCodec, ValueCodec, Metadata, Nodes, KeyConverter> SupportsMerkle<<Metadata as Mappable>::Key, M, S> for Sparse<KeyCodec, ValueCodec, Metadata, Nodes, KeyConverter>
where M: Mappable, S: KeyValueInspect + StorageInspect<Metadata, Error = Error>, Metadata: Mappable<Value = SparseMerkleMetadata, OwnedValue = SparseMerkleMetadata>, Self: BlueprintInspect<M, S>,

Source§

fn root(storage: &S, key: &Metadata::Key) -> StorageResult<MerkleRoot>

Returns the root of the Merkle tree.

Auto Trait Implementations§

§

impl<KeyCodec, ValueCodec, Metadata, Nodes, KeyConverter> Freeze for Sparse<KeyCodec, ValueCodec, Metadata, Nodes, KeyConverter>

§

impl<KeyCodec, ValueCodec, Metadata, Nodes, KeyConverter> RefUnwindSafe for Sparse<KeyCodec, ValueCodec, Metadata, Nodes, KeyConverter>
where KeyCodec: RefUnwindSafe, ValueCodec: RefUnwindSafe, Metadata: RefUnwindSafe, Nodes: RefUnwindSafe, KeyConverter: RefUnwindSafe,

§

impl<KeyCodec, ValueCodec, Metadata, Nodes, KeyConverter> Send for Sparse<KeyCodec, ValueCodec, Metadata, Nodes, KeyConverter>
where KeyCodec: Send, ValueCodec: Send, Metadata: Send, Nodes: Send, KeyConverter: Send,

§

impl<KeyCodec, ValueCodec, Metadata, Nodes, KeyConverter> Sync for Sparse<KeyCodec, ValueCodec, Metadata, Nodes, KeyConverter>
where KeyCodec: Sync, ValueCodec: Sync, Metadata: Sync, Nodes: Sync, KeyConverter: Sync,

§

impl<KeyCodec, ValueCodec, Metadata, Nodes, KeyConverter> Unpin for Sparse<KeyCodec, ValueCodec, Metadata, Nodes, KeyConverter>
where KeyCodec: Unpin, ValueCodec: Unpin, Metadata: Unpin, Nodes: Unpin, KeyConverter: Unpin,

§

impl<KeyCodec, ValueCodec, Metadata, Nodes, KeyConverter> UnwindSafe for Sparse<KeyCodec, ValueCodec, Metadata, Nodes, KeyConverter>
where KeyCodec: UnwindSafe, ValueCodec: UnwindSafe, Metadata: UnwindSafe, Nodes: UnwindSafe, KeyConverter: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> Conv for T

Source§

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more
Source§

impl<T> FmtForward for T

Source§

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.
Source§

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.
Source§

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.
Source§

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.
Source§

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.
Source§

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.
Source§

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.
Source§

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.
Source§

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<S> IteratorOverTable for S

Source§

fn iter_all_keys<M>( &self, direction: Option<IterDirection>, ) -> BoxedIter<'_, Result<M::OwnedKey>> ⓘ
where M: Mappable, Self: IterableTable<M>,

Returns an iterator over the all keys in the table.
Source§

fn iter_all_by_prefix_keys<M, P>( &self, prefix: Option<P>, ) -> BoxedIter<'_, Result<M::OwnedKey>> ⓘ
where M: Mappable, P: AsRef<[u8]>, Self: IterableTable<M>,

Returns an iterator over the all keys in the table with the specified prefix.
Source§

fn iter_all_by_start_keys<M>( &self, start: Option<&M::Key>, direction: Option<IterDirection>, ) -> BoxedIter<'_, Result<M::OwnedKey>> ⓘ
where M: Mappable, Self: IterableTable<M>,

Returns an iterator over the all keys in the table after a specific start key.
Source§

fn iter_all_filtered_keys<M, P>( &self, prefix: Option<P>, start: Option<&M::Key>, direction: Option<IterDirection>, ) -> BoxedIter<'_, Result<M::OwnedKey>> ⓘ
where M: Mappable, P: AsRef<[u8]>, Self: IterableTable<M>,

Returns an iterator over the all keys in the table with a prefix after a specific start key.
Source§

fn iter_all<M>( &self, direction: Option<IterDirection>, ) -> BoxedIter<'_, Result<(M::OwnedKey, M::OwnedValue)>> ⓘ
where M: Mappable, Self: IterableTable<M>,

Returns an iterator over the all entries in the table.
Source§

fn iter_all_by_prefix<M, P>( &self, prefix: Option<P>, ) -> BoxedIter<'_, Result<(M::OwnedKey, M::OwnedValue)>> ⓘ
where M: Mappable, P: AsRef<[u8]>, Self: IterableTable<M>,

Returns an iterator over the all entries in the table with the specified prefix.
Source§

fn iter_all_by_start<M>( &self, start: Option<&M::Key>, direction: Option<IterDirection>, ) -> BoxedIter<'_, Result<(M::OwnedKey, M::OwnedValue)>> ⓘ
where M: Mappable, Self: IterableTable<M>,

Returns an iterator over the all entries in the table after a specific start key.
Source§

fn iter_all_filtered<M, P>( &self, prefix: Option<P>, start: Option<&M::Key>, direction: Option<IterDirection>, ) -> BoxedIter<'_, Result<(M::OwnedKey, M::OwnedValue)>> ⓘ
where M: Mappable, P: AsRef<[u8]>, Self: IterableTable<M>,

Returns an iterator over the all entries in the table with a prefix after a specific start key.
Source§

impl<T> Pipe for T
where T: ?Sized,

Source§

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more
Source§

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more
Source§

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more
Source§

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more
Source§

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
where Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more
Source§

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.
Source§

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.
Source§

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.
Source§

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R, ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> StorageAsMut for T

Source§

fn storage<Type>(&mut self) -> StorageMut<'_, Self, Type>
where Type: Mappable,

Source§

fn storage_as_mut<Type>(&mut self) -> StorageMut<'_, Self, Type>
where Type: Mappable,

Source§

impl<T> StorageAsRef for T

Source§

fn storage<Type>(&self) -> StorageRef<'_, Self, Type>
where Type: Mappable,

Source§

fn storage_as_ref<Type>(&self) -> StorageRef<'_, Self, Type>
where Type: Mappable,

Source§

impl<T> Tap for T

Source§

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more
Source§

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more
Source§

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Immutable access to the Borrow<B> of a value. Read more
Source§

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Mutable access to the BorrowMut<B> of a value. Read more
Source§

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more
Source§

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more
Source§

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more
Source§

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more
Source§

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.
Source§

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.
Source§

fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.
Source§

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.
Source§

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.
Source§

impl<T> TryConv for T

Source§

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V