Struct MutationTask 

pub struct MutationTask<'a, N: Grammar, H: TaskHandle = TriggerHandle, S: SyncBuildHasher = RandomState> { /* private fields */ }

A task that grants access to change the content of the documents managed by the Analyzer.

This kind of task implements a MutationAccess trait through which you can create, delete, or edit the existing documents’ content, but you cannot read attributes of the semantic graph.

You may have as many instances of this task as needed at the same time, and you can use them from multiple threads to manage distinct documents.

The analyzer allows you to edit independent documents concurrently, but if two independent threads would edit the same document, one of them will block until another one finishes its job.

Trait Implementations

impl<'a, N: Grammar, H: TaskHandle, S: SyncBuildHasher> AbstractTask<N, H, S> for MutationTask<'a, N, H, S>

fn handle(&self) -> &H

Returns a handle of the task through which you can manually check if the task has been interrupted, and through which you can interrupt the task manually.

fn proceed(&self) -> AnalysisResult<()>

A convenient function that checks if the task was interrupted.

fn contains_doc(&self, id: Id) -> bool

Returns true, if the analyzer has a document with the id identifier.

fn read_doc(&self, id: Id) -> AnalysisResult<DocumentReadGuard<'_, N, S>>

Returns a RAII guard that provides read-only access to the analyzer’s document with specified id.

fn try_read_doc(&self, id: Id) -> Option<DocumentReadGuard<'_, N, S>>

Returns a RAII guard that provides read-only access to the analyzer’s document with specified id.

fn is_doc_mutable(&self, id: Id) -> bool

Returns true if the document with the specified id exists in the analyzer, and this document allows content edit operations.

fn is_doc_immutable(&self, id: Id) -> bool

Returns true if the document with the specified id exists in the analyzer, and this document does not allow content edit operations.

fn snapshot_class( &self, id: Id, class: &<N::Classifier as Classifier>::Class, ) -> AnalysisResult<Shared<HashSet<NodeRef, S>>>

Returns a snapshot of the node references set of the document with id that refer to syntax tree nodes belonging to specified class.

fn common(&self) -> &N::CommonSemantics

Provides access to the Analyzer’s common semantics, a special semantic feature that is instantiated during the Analyzer’s creation. It does not belong to any specific document and is common across the entire Analyzer.

impl<'a, N: Grammar, H: TaskHandle, S: SyncBuildHasher> Drop for MutationTask<'a, N, H, S>

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl<'a, N: Grammar, H: TaskHandle, S: SyncBuildHasher> MutationAccess<N, H, S> for MutationTask<'a, N, H, S>

fn add_mutable_doc(&mut self, text: impl Into<TokenBuffer<N::Token>>) -> Id

Creates a mutable Document inside the Analyzer.

fn add_immutable_doc(&mut self, text: impl Into<TokenBuffer<N::Token>>) -> Id

Creates an immutable Document inside the Analyzer.

fn write_to_doc( &mut self, id: Id, span: impl ToSpan, text: impl AsRef<str>, ) -> AnalysisResult<()>

Writes user-input edit into the document managed by the Analyzer.

fn remove_doc(&mut self, id: Id) -> bool

Removes a document managed by the Analyzer.

fn trigger_event(&mut self, id: Id, event: Event)

Invalidates semantic graph attributes associated with the corresponding event and the id parameters.