Struct SqliteStorage

pub struct SqliteStorage { /* private fields */ }

SQLite-based storage

Implementations

impl SqliteStorage

pub fn new() -> Result<Self>

Builds a new SQLite storage on the default path

pub fn new_in_memory() -> Result<Self>

Builds a new in-memory SQLite storage for testing purposes

pub fn insert_command(&self, command: &mut Command) -> Result<bool>

Inserts a command and updates its id with the inserted value.

If the command already exist on the database, its description will be updated.

Returns wether the command was inserted or not (updated)

pub fn insert_commands(&self, commands: &mut [Command]) -> Result<u64>

Inserts a bunch of commands and updates its id with the inserted value.

If any command already exist on the database, its description will be updated.

Returns the number of commands inserted (the rest are updated)

pub fn update_command(&self, command: &Command) -> Result<bool>

Updates an existing command

Returns wether the command exists and was updated or not.

pub fn increment_command_usage(&self, command_id: i64) -> Result<bool>

Updates an existing command by incrementing its usage by one

Returns wether the command exists and was updated or not.

pub fn delete_command(&self, command_id: i64) -> Result<bool>

Deletes an existing command

Returns wether the command exists and was deleted or not.

pub fn get_commands(&self, category: impl AsRef<str>) -> Result<Vec<Command>>

Get commands matching a category

pub fn find_commands(&self, search: impl AsRef<str>) -> Result<Vec<Command>>

Finds commands matching the given search criteria

pub fn export( &self, category: impl AsRef<str>, file_path: impl Into<String>, ) -> Result<usize>

Exports the commands from a given category into the given file path

Returns

The number of exported commands

pub fn import( &self, category: impl AsRef<str>, file_path: String, ) -> Result<u64>

Imports commands from the given file into a category.

Returns

The number of newly inserted commands

pub fn is_empty(&self) -> Result<bool>

Determines if the store is empty (no commands stored)

pub fn len(&self) -> Result<u64>

Returns the number of stored commands

pub fn insert_label_suggestion( &self, suggestion: &LabelSuggestion, ) -> Result<bool>

Inserts a label suggestion if it doesn’t exists.

Returns wether the suggestion was inserted or not (already existed)

pub fn update_label_suggestion( &self, suggestion: &mut LabelSuggestion, new_suggestion: impl Into<String>, ) -> Result<bool>

Updates an existing label suggestion

Returns wether the suggestion exists and was updated or not.

pub fn update_label_suggestion_usage( &self, suggestion: &LabelSuggestion, ) -> Result<bool>

Updates the usage of an existing label suggestion

Returns wether the suggestion exists and was updated or not.

pub fn delete_label_suggestion( &self, suggestion: &LabelSuggestion, ) -> Result<bool>

Deletes an existing label suggestion

Returns wether the suggestion exists and was deleted or not.

pub fn find_suggestions_for( &self, root_cmd: impl AsRef<str>, label: impl AsRef<str>, ) -> Result<Vec<LabelSuggestion>>

Finds label suggestions for the given root command and label

Trait Implementations

impl Drop for SqliteStorage

fn drop(&mut self)

Executes the destructor for this type.