Struct DynamicFieldKey

pub struct DynamicFieldKey<ParentID, K>(pub ParentID, pub K, pub TypeTag);

A chainable API for getting dynamic fields.

This allows you to start with either:

• a parent ID + key
• or pre-hashed child ID,

and then allows you to read the field

• consistently (with a version bound)
• or inconsistently (no version bound)

And take the object that was read from the store and:

• return the raw object
• or deserialize the field value from the object
• or just check if it exists

By chaining these together, we can have all the options above without a cross-product of functions for each case.

DynamicFieldKey represents the inputs into a dynamic field id computation (hash). Use it to start a lookup if you know the parent and key.

Tuple Fields

0: ParentID

1: K

2: TypeTag

Implementations

impl<ParentID, K> DynamicFieldKey<ParentID, K>

where ParentID: Into<SuiAddress> + Into<ObjectID> + Copy, K: Serialize + Debug,

pub fn object_id(&self) -> Result<ObjectID, SuiError>

Get the computed ID of the dynamic field.

pub fn into_unbounded_id(self) -> Result<UnboundedDynamicFieldID<K>, SuiError>

Convert the key into a UnboundedDynamicFieldID, which can be used to load the latest version of the field object.

pub fn into_id_with_bound( self, parent_version: SequenceNumber, ) -> Result<BoundedDynamicFieldID<K>, SuiError>

Convert the key into a BoundedDynamicFieldID, which can be used to load the field object with a version bound for consistent reads.

pub fn into_field<V>(self, value: V) -> Result<DynamicField<K, V>, SuiError>

where V: Serialize + DeserializeOwned + MoveTypeTagTrait,

Convert the key into a DynamicField, which contains the Field<K, V> object, that is, the value that would be stored in the field object.

Used to compute the contents of a field object without writing and then reading it back.