Struct DriveDocumentQueryFilter 

pub struct DriveDocumentQueryFilter<'a> {
    pub contract: &'a DataContract,
    pub document_type_name: String,
    pub action_clauses: DocumentActionMatchClauses,
}

Filter used to match document transitions for subscriptions.

Targets a specific data contract and document type, and carries action-specific match clauses via DocumentActionMatchClauses. Use matches_document_transition() and matches_original_document() to evaluate document transitions. validate() performs structural checks (document type exists, clause composition rules).

Fields

contract: &'a DataContract

DataContract

document_type_name: String

Document type name

action_clauses: DocumentActionMatchClauses

Action-specific clauses

Implementations

impl DriveDocumentQueryFilter<'_>

pub fn matches_document_transition( &self, document_transition: &DocumentTransition, batch_owner_value: Option<&Value>, ) -> TransitionCheckResult

Check a transition using only transition-level constraints.

When to run:

• Call this for each incoming transition before fetching the original document. It short-circuits on obvious mismatches and tells you if an original is needed at all for the final decision.

Returns:

• Pass if all applicable transition-level checks pass and no original is needed.
• Fail if any transition-level check fails (no need to fetch original).
• NeedsOriginal if transition-level checks pass but original clauses are non-empty and must be evaluated with the original document.

pub fn matches_original_document(&self, original_document: &Document) -> bool

Evaluates original-dependent clauses against the provided original Document.

When to run:

• After matches_document_transition returns NeedsOriginal and the caller fetches the original document.
• This evaluates only original-dependent clauses; transition-level checks were already applied during the first phase.

pub fn validate(&self) -> QuerySyntaxSimpleValidationResult

Validate the filter structure and clauses.

In addition to these validations, the subscription host should check the contract’s existence.

Trait Implementations

impl<'a> Clone for DriveDocumentQueryFilter<'a>

fn clone(&self) -> DriveDocumentQueryFilter<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for DriveDocumentQueryFilter<'a>

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

Formats the value using the given formatter.

impl<'a> PartialEq for DriveDocumentQueryFilter<'a>

fn eq(&self, other: &DriveDocumentQueryFilter<'a>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a> StructuralPartialEq for DriveDocumentQueryFilter<'a>