Enum Tool 

#[non_exhaustive]
pub enum Tool {
    Bold,
    Italic,
    Underline,
    Strike,
    Code,
    Link,
    Heading1,
    Heading2,
    Heading3,
    BulletList,
    OrderedList,
    Blockquote,
    CodeBlock,
    HorizontalRule,
    Undo,
    Redo,
}

One button of a rich text field’s toolbar. A tool is also a grant: the field keeps only the elements and attributes its tools produce, so a tool left off the toolbar cannot be typed, is dropped from a paste, and is removed from a forged post.

use tablo_core::{Field, Tool};

Field::rich_text(Post::fields().body()).toolbar(&[
    &[Tool::Bold, Tool::Italic, Tool::Link],
    &[Tool::BulletList, Tool::OrderedList],
]);

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

Bold

<strong>.

Italic

<em>.

Underline

<u>.

Strike

<s>.

Code

Inline <code>.

Link

<a href> to an http, https or mailto URL, or a relative one.

Heading1

<h1>.

Heading2

<h2>.

Heading3

<h3>.

BulletList

<ul> of <li>.

OrderedList

<ol> of <li>, which may set start and type.

Blockquote

<blockquote>.

CodeBlock

<pre><code>. The editor records a block’s language as a class, which cleaning drops, and the allowlist names elements, not where they nest, so a forged post keeps inline <code> too.

HorizontalRule

<hr>.

Undo

Undoes the last change; produces nothing.

Redo

Redoes the last undone change; produces nothing.

Implementations

impl Tool

pub const DEFAULT: &[&[Tool]]

The toolbar a rich text field shows unless it declares its own.

Trait Implementations

impl Clone for Tool

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Tool

impl Debug for Tool

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

Formats the value using the given formatter.

impl Eq for Tool

impl Hash for Tool

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Tool

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Tool