Struct Update 

pub struct Update {
    pub entity_key: Hash,
    pub btl: u64,
    pub data: Bytes,
    pub string_annotations: Vec<StringAnnotation>,
    pub numeric_annotations: Vec<NumericAnnotation>,
}

Type representing an update transaction in Arkiv. Used to update existing entities, including their data, BTL, and annotations.

Note: Each block represents ~2 seconds, eg. setting the BTL (blocks-to-live) to 15u64 is equal to 30 seconds of life for the entity.

Fields

entity_key: Hash

The key of the entity to update.

btl: u64

The updated block-to-live (BTL) for the entity.

data: Bytes

The updated data for the entity.

string_annotations: Vec<StringAnnotation>

Updated string annotations for the entity.

numeric_annotations: Vec<NumericAnnotation>

Updated numeric annotations for the entity.

Implementations

impl Update

pub fn new(entity_key: B256, payload: Vec<u8>, btl: u64) -> Self

Creates a new Update operation with empty annotations. Accepts an entity key, payload as bytes, and a BTL value.

pub fn from_string<T: Into<String>>( entity_key: B256, payload: T, btl: u64, ) -> Self

Creates a new Update request from any type that can be converted to String.

pub fn annotate_string( self, key: impl Into<String>, value: impl Into<String>, ) -> Self

Adds a string annotation to the entity. Returns the modified Update for chaining.

pub fn annotate_number(self, key: impl Into<String>, value: u64) -> Self

Adds a numeric annotation to the entity. Returns the modified Update for chaining.

Trait Implementations

impl Clone for Update

fn clone(&self) -> Update

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Update

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

Formats the value using the given formatter.

impl Decodable for Update

fn decode(b: &mut &[u8]) -> Result<Self>

Decodes the blob into the appropriate type. buf must be advanced past the decoded object.

impl Default for Update

fn default() -> Update

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Update

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Encodable for Update

fn length(&self) -> usize

Returns the length of the encoding of this type in bytes.

fn encode(&self, out: &mut dyn BufMut)

Encodes the type into the out buffer.