Skip to main content

Gesture

Enum Gesture 

Source
#[non_exhaustive]
pub enum Gesture {
Show 15 variants WrapRange(InlineKind), ToggleInline(InlineKind), SetBlock, ToggleBlockContainer(BlockContainerKind), InsertThematicBreak, ToggleCodeBlock, SetCodeLanguage, ToggleTaskItem, SetTaskChecked, ToggleTaskChecked, InsertLink, InsertImage, InsertFootnote, InsertLiteral, InsertLineBreak,
}
Expand description

One authoring gesture, named with whatever kind it takes — the question Format::supports answers.

Twig’s formats are ragged: Djot spells all eight inline marks and Markdown three, HTML spells marks and nothing block-level, XML and AsciiDoc spell nothing. Every Editor method already reports that as Error::UnsupportedFormat — but only once called, which is too late for a UI that wants to disable the button rather than let it fail.

A variant carries a kind exactly where the Editor method takes one, so the query is spelled with the same value as the call:

if Format::Markdown.supports(Gesture::ToggleInline(InlineKind::Mark)) {
    // never runs: `==mark==` is emit-only in Markdown.
}

Only the gestures with a format-level gate appear. Three are absent for two different reasons:

  • Editor::split_block consults the format only for the block it lands in (a fence inside a code block, a heading marker inside a heading, nothing at all in a paragraph). Its answer is a property of the caret, so no format-only query could be honest about it.
  • Editor::renumber_ordered_lists and the table ops read no format spelling at all — they rewrite structure already in the source and refuse on position, never on format.

#[non_exhaustive] for the reason Format is: the gesture list grows with the editor surface, and a caller matching on this should not need a rebuild.

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

WrapRange(InlineKind)

§

ToggleInline(InlineKind)

§

SetBlock

§

ToggleBlockContainer(BlockContainerKind)

§

InsertThematicBreak

§

ToggleCodeBlock

§

SetCodeLanguage

§

ToggleTaskItem

§

SetTaskChecked

§

ToggleTaskChecked

§

InsertImage

§

InsertFootnote

§

InsertLiteral

§

InsertLineBreak

Trait Implementations§

Source§

impl Clone for Gesture

Source§

fn clone(&self) -> Gesture

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 Copy for Gesture

Source§

impl Debug for Gesture

Source§

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

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

impl Eq for Gesture

Source§

impl PartialEq for Gesture

Source§

fn eq(&self, other: &Gesture) -> 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 Gesture

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