Struct BufferTracker 

pub struct BufferTracker { /* private fields */ }

A tracker to keep up to date on changes to Buffers

This struct is capable of tracking all the Changes that happen to any Buffer. That happens through the BufferTracker::parts method, which gives a BufferParts struct, including the Buffer’s Bytes, Tags, Selections, as well as an ExactSizeIterator over the Changes that took place since the last call to this function, and a RangesToUpdate associated with the Buffer

The RangesToUpdate is a struct that keeps track of the ranges where changes have taken place, and informs you on which ones need to be updated based on what is currently visible on screen. At the start, this will include the full range of the Buffer, since Duat assumes that you will want to update the whole buffer.

This struct, alongside PerBuffer, allows for a nice and standardised workflow for “parsers”, which essentially update the Buffers based on changes that took place and on what is presently visible. One example of such a parser can be seen in the duat-treesitter crate.

Implementations

impl BufferTracker

pub const fn new() -> Self

Returns a new ChangesFetcher

This struct can be stored in a static variable, since this function is const. You can then use the same ChangesFetcher to fetch Changes from all Buffers

pub fn parts<'b>(&self, buf: &'b mut Buffer) -> Option<BufferParts<'b>>

Gets the BufferParts of a Buffer

This struct consists of the normal TextParts, (Bytes, Tags, Selections), but it also includes an Iterator over all the Changes that took place since the last time this function was called by this tracker on this Buffer.

It is intended for borrowing the Tags mutably, whilst reading from the Bytes, Selections and the Changes that took place.

Returns None when calling this function on a Buffer without first having called BufferTracker::register_buffer on it.

pub fn register_buffer(&self, buf: &mut Buffer)

Registers a Buffer on the list of those that should be tracked

Does nothing if the Buffer was already registered.

Trait Implementations

impl Default for BufferTracker

fn default() -> Self

Returns the “default value” for a type.