Enum SnippetToken 

pub enum SnippetToken {
    Literal(String),
    Tabstop(u32),
    Placeholder {
        idx: u32,
        default: SnippetBody,
    },
    Choice {
        idx: u32,
        options: Vec<ChoiceOption>,
    },
    Variable {
        name: String,
        default: Option<SnippetBody>,
    },
    Transform {
        target: TransformTarget,
        pattern: String,
        replacement: String,
        flags: String,
    },
}

One token from a parsed snippet body.

Variants

Literal(String)

Plain text that lands in the rendered output verbatim. Adjacent literal tokens are merged by the parser so a rendered body never has two literals in a row.

Tabstop(u32)

$N – bare tabstop. $0 is the final cursor position (exited automatically); $1..$N are visited in order.

Placeholder

${N:default} – tabstop with default text. The default can itself contain nested tokens (e.g. ${1:foo${2:bar}}) so users can place inner placeholders inside.

Fields

idx: u32

default: SnippetBody

Choice

${N|opt1,opt2,opt3|} – pick from a fixed list. The host’s choice-picker UI surfaces these on focus.

Fields

idx: u32

options: Vec<ChoiceOption>

Variable

$NAME / ${NAME} / ${NAME:fallback} – variable substitution. default runs only when the variable resolves to None.

Fields

name: String

default: Option<SnippetBody>

Transform

${N/pat/repl/flags} / ${NAME/pat/repl/flags} – regex transformation on the bound text. v1 parses but renders as the bound text un-transformed; full regex support lands as polish (transformations are rare in practice, and supporting the full regex format syntax is its own feature).

Fields

target: TransformTarget

pattern: String

replacement: String

flags: String

Trait Implementations

impl Clone for SnippetToken

fn clone(&self) -> SnippetToken

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SnippetToken

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SnippetToken

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for SnippetToken

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for SnippetToken

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for SnippetToken