Struct FilterPatch 

pub struct FilterPatch {
    pub mode: Option<FilterMode>,
    /* private fields */
}

a staged set of filter mutations. all methods accumulate changes without touching the database. call FilterPatch::apply to commit the entire patch atomically.

obtain an instance by calling any mutation method on FilterControl, or via FilterPatch::new to start from a blank patch.

Fields

mode: Option<FilterMode>

if set, replaces the current indexing mode.

Implementations

impl FilterPatch

pub fn new(control: &FilterControl) -> Self

create a new blank patch associated with the given FilterControl.

pub fn set_mode(self, mode: FilterMode) -> Self

set the indexing mode. see FilterControl for mode semantics.

pub fn set_signals( self, signals: impl IntoIterator<Item = impl Into<String>>, ) -> Self

replace the entire signals set. existing signals are removed.

pub fn append_signals( self, signals: impl IntoIterator<Item = impl Into<String>>, ) -> Self

add multiple signals without disturbing existing ones.

pub fn add_signal(self, signal: impl Into<String>) -> Self

add a single signal. no-op if already present.

pub fn remove_signal(self, signal: impl Into<String>) -> Self

remove a single signal. no-op if not present.

pub fn set_collections( self, collections: impl IntoIterator<Item = impl Into<String>>, ) -> Self

replace the entire collections set. pass an empty iterator to store all collections.

pub fn append_collections( self, collections: impl IntoIterator<Item = impl Into<String>>, ) -> Self

add multiple collections without disturbing existing ones.

pub fn add_collection(self, collection: impl Into<String>) -> Self

add a single collection filter. no-op if already present.

pub fn remove_collection(self, collection: impl Into<String>) -> Self

remove a single collection filter. no-op if not present.

pub fn set_excludes( self, excludes: impl IntoIterator<Item = impl Into<String>>, ) -> Self

replace the entire excludes set.

pub fn append_excludes( self, excludes: impl IntoIterator<Item = impl Into<String>>, ) -> Self

add multiple DIDs to the excludes set without disturbing existing ones.

pub fn add_exclude(self, did: impl Into<String>) -> Self

add a single DID to the excludes set. no-op if already excluded.

pub fn remove_exclude(self, did: impl Into<String>) -> Self

remove a single DID from the excludes set. no-op if not present.

pub async fn apply(self) -> Result<FilterSnapshot>

commit the patch atomically to the database and update the in-memory filter. returns the updated FilterSnapshot.