Skip to main content

HighlightMask

Struct HighlightMask 

Source
pub struct HighlightMask { /* private fields */ }
Expand description

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 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.

Implementations§

Source§

impl HighlightMask

Source

pub fn all() -> Self

Show every session attached to the document. The default, and the shape of a plain snapshot_flow().

Source

pub fn none() -> Self

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

Source

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).

Source

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

Add a session to a mask that already names some (a no-op on HighlightMask::all, which already admits everything).

Trait Implementations§

Source§

impl Clone for HighlightMask

Source§

fn clone(&self) -> HighlightMask

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for HighlightMask

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for HighlightMask

Source§

fn default() -> HighlightMask

Returns the “default value” for a type. Read more
Source§

impl Eq for HighlightMask

Source§

impl PartialEq for HighlightMask

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for HighlightMask

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.