Struct RemoveDocumentsParams 

pub struct RemoveDocumentsParams {
    pub document_ids: Vec<u128>,
}

Parameters for removing documents from the index

Contains document IDs to be removed in a batch operation.

Fields

document_ids: Vec<u128>

Vector of document IDs to remove from the index

Implementations

impl RemoveDocumentsParams

pub fn new(document_ids: Vec<u128>) -> Result<Self, ShardexError>

Create new remove documents parameters

Arguments

• document_ids - Vector of document IDs to remove

pub fn validate(&self) -> Result<(), ShardexError>

Validate the remove documents parameters

pub fn len(&self) -> usize

Get the number of documents to remove

pub fn is_empty(&self) -> bool

Check if the document IDs collection is empty

Trait Implementations

impl ApiOperation<ShardexContext, RemoveDocumentsParams> for RemoveDocuments

type Output = RemovalStats

The type returned by a successful operation execution.

type Error = ShardexError

The error type returned when an operation fails.

fn execute( context: &mut ShardexContext, parameters: &RemoveDocumentsParams, ) -> Result<Self::Output, Self::Error>

Execute the API operation with the given context and properties.

impl Clone for RemoveDocumentsParams

fn clone(&self) -> RemoveDocumentsParams

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RemoveDocumentsParams

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

Formats the value using the given formatter.