Struct Command

pub struct Command {
    pub id: Uuid,
    pub category: String,
    pub source: String,
    pub alias: Option<String>,
    pub cmd: String,
    pub flat_cmd: String,
    pub description: Option<String>,
    pub flat_description: Option<String>,
    pub tags: Option<Vec<String>>,
    pub created_at: DateTime<Utc>,
    pub updated_at: Option<DateTime<Utc>>,
}

Fields

id: Uuid

Unique identifier for the command

category: String

Category of the command (user, workspace or tldr’s category)

source: String

Category of the command (user, tldr, import, workspace)

alias: Option<String>

Optional alias for easier recall

cmd: String

The actual command string, potentially with {{placeholders}}

flat_cmd: String

Flattened version of cmd

description: Option<String>

Optional user-provided description

flat_description: Option<String>

Flattened version of description

tags: Option<Vec<String>>

Tags associated with the command (including the hashtag #)

created_at: DateTime<Utc>

The date and time when the command was created

updated_at: Option<DateTime<Utc>>

The date and time when the command was last updated

Implementations

impl Command

pub fn new( category: impl Into<String>, source: impl Into<String>, cmd: impl Into<String>, ) -> Self

Creates a new command, with zero usage

pub fn with_alias(self, alias: Option<String>) -> Self

Updates the alias of the command

pub fn with_cmd(self, cmd: String) -> Self

Updates the cmd of the command

pub fn with_description(self, description: Option<String>) -> Self

Updates the description (and tags) of the command

Trait Implementations

impl Clone for Command

fn clone(&self) -> Command

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Command

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

Formats the value using the given formatter.

impl Display for Command

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

Formats the value using the given formatter.

impl From<CommandWidget> for Command

fn from(value: CommandWidget) -> Self

Converts to this type from the input type.

impl<'a> TryFrom<&'a Row<'a>> for Command

type Error = Error

The type returned in the event of a conversion error.

fn try_from(row: &'a Row<'a>) -> Result<Self, Self::Error>

Performs the conversion.