Struct SnippetsFile

pub struct SnippetsFile {
    pub snippets: HashMap<String, Snippet>,
}

Snippets File Manager

📁 A file controller for managing VS Code snippets collections and their file operations.

Overview

SnippetsFile provides a convenient way to:

• 📦 Create and manage collections of code snippets
• 🔄 Serialize snippets to VS Code compatible format
• 💾 Save snippets to the filesystem

Usage

✨ Creating a new snippets file:

let file = SnippetsFile::new(vec![
    Snippet::new("print", vec!["println!(\"$0\");"]),
    Snippet::new("debug", vec!["dbg!($0);"])
]);

➕ Adding snippets dynamically:

let mut file = SnippetsFile::new(vec![]);
 
// Add single snippet
file.add_snippet(Snippet::new("log", vec!["log::info!(\"$0\")"]));
 
// Add multiple snippets
file.add_snippets(vec![
    Snippet::new("error", vec!["log::error!(\"$0\");"]),
    Snippet::new("warn", vec!["log::warn!(\"$0\");"])
]);

💾 Saving to file:

let file = SnippetsFile::new(vec![
    Snippet::new("test", vec![
        "#[test]",
        "fn test_name() {",
        "    ",
        "}"
    ])
]);
 
// Saves to VS Code snippets directory
file.write_to("./snippets/rust.code-snippets")?;

📋 File Format

The snippets are saved in VS Code compatible JSON format:

{
    "print": {
        "prefix": "print",
        "body": [
            "println!(\"Hello\");"
        ],
        "description": "Basic print statement"
    }
}

⚠️ Error Handling

The structure uses custom Result type for error handling:

• 🔄 JSON serialization errors
• 📂 File system operation errors
• 📁 Directory creation errors

User Snippets

📝 You can write this snippets to your VS Code custom user snippets folder Locales:

• 🗂️ Windows: %APPDATA%/Code/User/snippets
• 🍎 MacOS: ~/Library/Application Support/Code/User/snippets
• 🐧 Linux: ~/.config/Code/User/snippets

💡 Or simply access it via VS Code:

1. Press Ctrl/Cmd + Shift + P
2. Type “Snippets: Configure User Snippets”
3. Select the language or create a new snippet file

Fields

snippets: HashMap<String, Snippet>

Implementations

impl SnippetsFile

pub fn new<Sn: Into<Snippet>>(snippets: impl IntoIterator<Item = Sn>) -> Self

Creates a new snippets file controller

pub fn add_snippet<S: Into<Snippet>>(&mut self, snippet: S)

Adds a new snippet to the collection

pub fn add_snippets<S: Into<Snippet>>( &mut self, snippets: impl IntoIterator<Item = S>, )

Adds a new snippets to the collection

pub fn to_json(&self) -> Result<String>

Converts the snippets to json string

pub fn write_to(&self, path: &str) -> Result<()>

Writes the snippets to file path

Trait Implementations

impl Clone for SnippetsFile

fn clone(&self) -> SnippetsFile

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SnippetsFile

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

Formats the value using the given formatter.

impl Serialize for SnippetsFile

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

where __S: Serializer,

Serialize this value into the given Serde serializer.