Struct IntelliShellService

pub struct IntelliShellService { /* private fields */ }

Service for managing user commands in IntelliShell

Implementations

impl IntelliShellService

pub async fn load_workspace_commands(&self) -> Result<u64>

Loads workspace commands from the .intellishell file in the current working directory setting up the temporary tables in the database if they don’t exist.

Returns the number of commands loaded.

pub async fn is_storage_empty(&self) -> Result<bool>

Returns whether the commands storage is empty

pub async fn insert_command( &self, command: Command, ) -> Result<Command, InsertError>

Bookmarks a new command

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

Updates an existing command

pub async fn increment_command_usage( &self, command_id: Uuid, ) -> Result<i32, UpdateError>

Increases the usage of a command, returning the new usage count

pub async fn delete_command(&self, id: Uuid) -> Result<()>

Deletes an existing command

pub async fn search_tags( &self, mode: SearchMode, user_only: bool, query: &str, cursor_pos: usize, ) -> Result<Option<Vec<(String, u64, bool)>>, SearchError>

Searches for tags based on a query string

pub async fn search_commands( &self, mode: SearchMode, user_only: bool, query: &str, ) -> Result<(Vec<Command>, bool), SearchError>

Searches for commands based on a query string, returning both the command and whether it was an alias match

impl IntelliShellService

pub async fn import_commands( &self, args: ImportCommandsProcess, gist_config: GistConfig, ) -> Result<(u64, u64), ImportExportError>

Import commands, returning the number of new commands inserted and skipped (because they already existed)

pub async fn export_commands( &self, args: ExportCommandsProcess, gist_config: GistConfig, ) -> Result<u64, ImportExportError>

Exports commands, returning the number of commands exported

impl IntelliShellService

pub async fn clear_tldr_commands(&self, category: Option<String>) -> Result<u64>

Removes tldr commands matching the given criteria.

Returns the number of commands removed

pub async fn fetch_tldr_commands( &self, category: Option<String>, commands: Vec<String>, ) -> Result<(u64, u64)>

Fetches and imports tldr commands matching the given criteria.

Returns the number of new commands inserted and potentially updated (because they already existed)

impl IntelliShellService

pub fn replace_command_variables( &self, command: String, values: Vec<(String, Option<String>)>, use_env: bool, ) -> Result<String, Vec<String>>

Replaces the variables found in a command with their values.

If one or more values are not found, they will be returned as an error.

pub async fn search_variable_suggestions( &self, root_cmd: &str, variable: &Variable, context: impl IntoIterator<Item = (String, String)>, ) -> Result<Vec<VariableSuggestion>>

Searches suggestions for the given variable

pub async fn insert_variable_value( &self, value: VariableValue, ) -> Result<VariableValue, InsertError>

Inserts a new variable value

pub async fn update_variable_value( &self, value: VariableValue, ) -> Result<VariableValue, UpdateError>

Updates an existing variable value

pub async fn increment_variable_value_usage( &self, value_id: i32, context: impl IntoIterator<Item = (String, String)>, ) -> Result<i32, UpdateError>

Increases the usage of a variable value, returning the new usage count

pub async fn delete_variable_value(&self, id: i32) -> Result<()>

Deletes an existing variable value

impl IntelliShellService

pub async fn check_new_version(&self) -> Result<Option<Version>>

Checks if there’s a new version available, returning the version if so

impl IntelliShellService

pub fn new( storage: SqliteStorage, tuning: SearchTuning, data_dir: impl AsRef<Path>, check_updates: bool, ) -> Self

Creates a new instance of IntelliShellService with the provided storage

pub async fn query(&self, sql: String) -> Result<String>

Trait Implementations

impl Clone for IntelliShellService

fn clone(&self) -> IntelliShellService

Returns a duplicate of the value.

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

Performs copy-assignment from source.