Struct DHTTransaction 

pub struct DHTTransaction { /* private fields */ }

DHT Transactions the way you perform multiple simulateous atomic operations over a set of DHT records.

DHT operations performed out of a transaction may be processed in any order, and only operate on one subkey at a time for a given record. Transactions allow you to bind a set of operations so they all succeed, or fail together, and at the same time.

Transactional DHT operations can only be performed when the node is online, and will error with VeilidAPIError::TryAgain if offline.

Transactions must be committed when all of their operations are registered, or rolled back if the group of operations is to be cancelled.

Implementations

impl DHTTransaction

pub fn api(&self) -> VeilidAPI

Get the VeilidAPI object that created this DHTTransaction.

pub async fn commit(self) -> VeilidAPIResult<()>

Commit the transaction All write operations are performed atomically

pub async fn rollback(self) -> VeilidAPIResult<()>

Rollback the transaction No write operations are performed,

pub async fn set( &self, record_key: RecordKey, subkey: ValueSubkey, data: Vec<u8>, options: Option<DHTTransactionSetValueOptions>, ) -> VeilidAPIResult<Option<ValueData>>

Add a set_dht_value operation to the transaction

• Will fail if performed offline
• Will fail if existing offline writes exist for this record key

The writer, if specified, will override the ‘default_writer’ specified when the record is opened.

Returns None if the value was successfully set. Returns Some(data) if the value set was older than the one available on the network.

pub async fn get( &self, record_key: RecordKey, subkey: ValueSubkey, ) -> VeilidAPIResult<Option<ValueData>>

Perform a get_dht_value operation inside the transaction

• Will fail if performed offline
• Will pull the latest value from the network, will fail if the local value is newer
• Will fail if existing offline writes exist for this record key

Returns None if the value subkey has not yet been set. Returns Some(data) if the value subkey has valid data.

pub async fn inspect( &self, record_key: RecordKey, subkeys: Option<ValueSubkeyRangeSet>, scope: DHTReportScope, ) -> VeilidAPIResult<DHTRecordReport>

Perform a inspect_dht_record operation inside the transaction

• Does not perform any network activity, as the transaction state keeps all of the required information after the begin

For information on arguments, see RoutingContext::inspect_dht_record

Returns a DHTRecordReport with the subkey ranges that were returned that overlapped the schema, and sequence numbers for each of the subkeys in the range.

Trait Implementations

impl Clone for DHTTransaction

fn clone(&self) -> DHTTransaction

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DHTTransaction

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

Formats the value using the given formatter.