Struct ExistenceFilter

pub struct ExistenceFilter {
    pub count: Option<i32>,
    pub target_id: Option<i32>,
    pub unchanged_names: Option<BloomFilter>,
}

A digest of all the documents that match a given target.

This type is not used in any activity, and only used as part of another schema.

Fields

count: Option<i32>

The total count of documents that match target_id. If different from the count of documents in the client that match, the client must manually determine which documents no longer match the target. The client can use the unchanged_names bloom filter to assist with this determination by testing ALL the document names against the filter; if the document name is NOT in the filter, it means the document no longer matches the target.

target_id: Option<i32>

The target ID to which this filter applies.

unchanged_names: Option<BloomFilter>

A bloom filter that, despite its name, contains the UTF-8 byte encodings of the resource names of ALL the documents that match target_id, in the form projects/{project_id}/databases/{database_id}/documents/{document_path}. This bloom filter may be omitted at the server’s discretion, such as if it is deemed that the client will not make use of it or if it is too computationally expensive to calculate or transmit. Clients must gracefully handle this field being absent by falling back to the logic used before this field existed; that is, re-add the target without a resume token to figure out which documents in the client’s cache are out of sync.

Trait Implementations

impl Clone for ExistenceFilter

fn clone(&self) -> ExistenceFilter

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ExistenceFilter

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

Formats the value using the given formatter.

impl Default for ExistenceFilter

fn default() -> ExistenceFilter

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ExistenceFilter

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ExistenceFilter

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Part for ExistenceFilter