Struct TrailLocking 

pub struct TrailLocking<'a, C> { /* private fields */ }

Locking API scoped to a specific trail.

This handle updates the trail’s locking configuration and queries whether an individual record is currently locked against deletion.

Implementations

impl<'a, C> TrailLocking<'a, C>

pub fn using_capability(self, capability_id: ObjectID) -> Self

Uses the provided capability as the auth capability for subsequent write operations.

pub fn update<S>( &self, config: LockingConfig, ) -> Result<TransactionBuilder<UpdateLockingConfig>, Error>

where C: AuditTrailFull + CoreClient<S>, S: Signer<IotaKeySignature> + OptionalSync,

Replaces the full locking configuration for the trail.

This overwrites all three locking dimensions at once: record delete window, trail delete lock, and write lock. The supplied LockingConfig is validated before the transaction is constructed.

Errors

Returns Error::InvalidArgument when config contains:

• delete_record_window using LockingWindow::CountBased with count == 0 (mirrors the Move ECountWindowMustBePositive abort).
• delete_trail_lock using TimeLock::UntilDestroyed (mirrors the Move EUntilDestroyedNotSupportedForDeleteTrail abort).

pub fn update_delete_record_window<S>( &self, window: LockingWindow, ) -> Result<TransactionBuilder<UpdateDeleteRecordWindow>, Error>

where C: AuditTrailFull + CoreClient<S>, S: Signer<IotaKeySignature> + OptionalSync,

Updates only the delete-record window.

Count-based windows protect the last N records present in trail order at the start of each call that consults the window. count must be positive; pass LockingWindow::None to remove the lock. Large count values increase delete gas linearly because the on-chain check walks backward from the tail to determine the protected window’s lower bound.

Errors

Returns Error::InvalidArgument when window is LockingWindow::CountBased with count == 0 (mirrors the Move ECountWindowMustBePositive abort).

pub fn update_delete_trail_lock<S>( &self, lock: TimeLock, ) -> Result<TransactionBuilder<UpdateDeleteTrailLock>, Error>

where C: AuditTrailFull + CoreClient<S>, S: Signer<IotaKeySignature> + OptionalSync,

Updates only the delete-trail time lock.

Errors

Returns Error::InvalidArgument when lock is TimeLock::UntilDestroyed (mirrors the Move EUntilDestroyedNotSupportedForDeleteTrail abort).

pub fn update_write_lock<S>( &self, lock: TimeLock, ) -> TransactionBuilder<UpdateWriteLock>

where C: AuditTrailFull + CoreClient<S>, S: Signer<IotaKeySignature> + OptionalSync,

Updates only the write lock.

pub async fn is_record_locked( &self, sequence_number: u64, ) -> Result<bool, Error>

where C: AuditTrailReadOnly,

Returns true when the given record is currently locked against deletion.

For count-based windows, the check determines the protected window’s lower bound by walking back from the current tail at call time; time-based locks are evaluated against the clock timestamp at call time. The result reflects the trail snapshot observed by this read-only call.

Errors

Returns an error if the lock state cannot be computed from the current on-chain state.

Trait Implementations

impl<'a, C: Clone> Clone for TrailLocking<'a, C>

fn clone(&self) -> TrailLocking<'a, C>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a, C: Debug> Debug for TrailLocking<'a, C>

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

Formats the value using the given formatter.