Struct vscode_generator::snippets::snippets_doc::SnippetsDoc

pub struct SnippetsDoc {
    pub language: String,
    pub title: String,
    pub description: String,
    pub body: Vec<(String, String)>,
}

The snippets documentation generator

• language - the snippets programming language name
• title - the snippets group name
• description - the snippets group description
• body - the documentation body, where ‘<(SNIPPET_PREFIX, SNIPPET_DESCRIPTION)>’

Fields

language: String

title: String

description: String

body: Vec<(String, String)>

Implementations

impl SnippetsDoc

pub fn new<S>(lang: S, title: S, descr: S) -> Self

where S: Into<String>,

Creates a new ‘SnippetsDoc’ object

• lang - the programming language name
• title - the snippets group name
• descr - the snippets group description

pub fn clear_body(&mut self)

Clears the documentation body contents

pub fn write_line<S>(&mut self, prefix: S, descr: S)

where S: Into<String>,

Writing a new line to documentation body

• prefix - the snippet prefix text
• descr - the snippet description no_run .write_line("st", "struct Name { ... }");

pub fn to_string(&self) -> String

Converts the documentation object to string

Trait Implementations

impl Clone for SnippetsDoc

fn clone(&self) -> SnippetsDoc

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SnippetsDoc

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

Formats the value using the given formatter.

impl Into<String> for SnippetsDoc

fn into(self) -> String

Converts the documentation object to string