Trait Delete

pub trait Delete:
    Unpin
    + Send
    + Sync {
    // Required methods
    fn delete(&mut self, path: &str, args: OpDelete) -> Result<()>;
    fn flush(&mut self) -> impl Future<Output = Result<usize>> + MaybeSend;
}

The Delete trait defines interfaces for performing deletion operations.

Required Methods

fn delete(&mut self, path: &str, args: OpDelete) -> Result<()>

Requests deletion of a resource at the specified path with optional arguments

Parameters

• path: The path of the resource to delete
• args: Additional arguments for the delete operation

Returns

• Ok(()): The deletion request has been successfully queued (does not guarantee actual deletion)
• Err(err): An error occurred and the deletion request was not queued

Notes

This method just queue the delete request. The actual deletion will be performed when flush is called.

fn flush(&mut self) -> impl Future<Output = Result<usize>> + MaybeSend

Flushes the deletion queue to ensure queued deletions are executed

Returns

• Ok(0): All queued deletions have been processed or the queue is empty.
• Ok(count): The number of resources successfully deleted. Implementations should return an error if the queue is non-empty but no resources were deleted
• Err(err): An error occurred while performing the deletions

Notes

• This method is asynchronous and will wait for queued deletions to complete

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementations on Foreign Types

impl Delete for ()

fn delete(&mut self, _: &str, _: OpDelete) -> Result<()>

async fn flush(&mut self) -> Result<usize>

impl<T: DeleteDyn + ?Sized> Delete for Box<T>

fn delete(&mut self, path: &str, args: OpDelete) -> Result<()>

async fn flush(&mut self) -> Result<usize>

Implementors

impl<D: BatchDelete> Delete for BatchDeleter<D>

impl<D: OneShotDelete> Delete for OneShotDeleter<D>