Struct HighlightMask 

pub struct HighlightMask { /* private fields */ }

Which highlight sessions a particular view renders.

Two panes over one shared document can carry different find queries, so “which highlights to show” is a property of the view, not the document. A snapshot is built under a mask; only the sessions the mask admits contribute spans, and the effective HighlighterKind is the join over just those.

The default (HighlightMask::all) shows every shared session, the behaviour of the old snapshot_flow(). HighlightMask::none shows none, the old snapshot_flow_without_highlights(), and it must stay exactly as cheap, since every read-only preview pane uses it. An OptIn session is shown by neither until with names it.

Implementations

impl HighlightMask

pub fn all() -> Self

Show every shared session attached to the document. The default, and the shape of a plain snapshot_flow(). An OptIn session needs with on top.

pub fn none() -> Self

Show no highlights at all — as cheap as the old show_highlights = false.

pub fn only(ids: impl IntoIterator<Item = SessionId>) -> Self

Show only the named sessions (e.g. the shared syntax + spell sessions plus this view’s own find session), whatever their visibility: naming a session is asking for it, so an OptIn id listed here is admitted.

pub fn with(self, id: SessionId) -> Self

Ask for one more session by name.

On a mask that already names a set (only / none) this adds to it. On all it admits one OptIn session without narrowing anything else, which is the shape a view wants when it owns a private layer and still wants the spell squiggles, comment underlines and ambient caret band it holds no handle on.

Trait Implementations

impl Clone for HighlightMask

fn clone(&self) -> HighlightMask

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HighlightMask

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

Formats the value using the given formatter.

impl Default for HighlightMask

fn default() -> HighlightMask

Returns the “default value” for a type.

impl Eq for HighlightMask

impl PartialEq for HighlightMask

fn eq(&self, other: &HighlightMask) -> bool

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for HighlightMask