Struct History

pub struct History {
    pub id: HistoryId,
    pub timestamp: OffsetDateTime,
    pub duration: i64,
    pub exit: i64,
    pub command: String,
    pub cwd: String,
    pub session: String,
    pub hostname: String,
    pub deleted_at: Option<OffsetDateTime>,
}

Client-side history entry.

Client stores data unencrypted, and only encrypts it before sending to the server.

To create a new history entry, use one of the builders:

• History::import() to import an entry from the shell history file
• History::capture() to capture an entry via hook
• History::from_db() to create an instance from the database entry

Fields

id: HistoryId

A client-generated ID, used to identify the entry when syncing.

Stored as client_id in the database.

timestamp: OffsetDateTime

When the command was run.

duration: i64

How long the command took to run.

exit: i64

The exit code of the command.

command: String

The command that was run.

cwd: String

The current working directory when the command was run.

session: String

The session ID, associated with a terminal session.

hostname: String

The hostname of the machine the command was run on.

deleted_at: Option<OffsetDateTime>

Timestamp, which is set when the entry is deleted, allowing a soft delete.

Implementations

impl History

pub fn serialize(&self) -> Result<DecryptedData>

pub fn deserialize(bytes: &[u8], version: &str) -> Result<History>

pub fn import() -> HistoryImportedBuilder

Builder for a history entry that is imported from shell history.

The only two required fields are timestamp and command.

Examples

use atuin_client::history::History;

let history: History = History::import()
    .timestamp(time::OffsetDateTime::now_utc())
    .command("ls -la")
    .build()
    .into();

If shell history contains more information, it can be added to the builder:

use atuin_client::history::History;

let history: History = History::import()
    .timestamp(time::OffsetDateTime::now_utc())
    .command("ls -la")
    .cwd("/home/user")
    .exit(0)
    .duration(100)
    .build()
    .into();

Unknown command or command without timestamp cannot be imported, which is forced at compile time:

use atuin_client::history::History;

// this will not compile because timestamp is missing
let history: History = History::import()
    .command("ls -la")
    .build()
    .into();

pub fn capture() -> HistoryCapturedBuilder

Builder for a history entry that is captured via hook.

This builder is used only at the start step of the hook, so it doesn’t have any fields which are known only after the command is finished, such as exit or duration.

Examples

use atuin_client::history::History;

let history: History = History::capture()
    .timestamp(time::OffsetDateTime::now_utc())
    .command("ls -la")
    .cwd("/home/user")
    .build()
    .into();

Command without any required info cannot be captured, which is forced at compile time:

use atuin_client::history::History;

// this will not compile because `cwd` is missing
let history: History = History::capture()
    .timestamp(time::OffsetDateTime::now_utc())
    .command("ls -la")
    .build()
    .into();

pub fn daemon() -> HistoryDaemonCaptureBuilder

Builder for a history entry that is captured via hook, and sent to the daemon.

This builder is used only at the start step of the hook, so it doesn’t have any fields which are known only after the command is finished, such as exit or duration.

It does, however, include information that can usually be inferred.

This is because the daemon we are sending a request to lacks the context of the command

Examples

use atuin_client::history::History;

let history: History = History::daemon()
    .timestamp(time::OffsetDateTime::now_utc())
    .command("ls -la")
    .cwd("/home/user")
    .session("018deb6e8287781f9973ef40e0fde76b")
    .hostname("computer:ellie")
    .build()
    .into();

Command without any required info cannot be captured, which is forced at compile time:

use atuin_client::history::History;

// this will not compile because `hostname` is missing
let history: History = History::daemon()
    .timestamp(time::OffsetDateTime::now_utc())
    .command("ls -la")
    .cwd("/home/user")
    .session("018deb6e8287781f9973ef40e0fde76b")
    .build()
    .into();

pub fn from_db() -> HistoryFromDbBuilder

Builder for a history entry that is imported from the database.

All fields are required, as they are all present in the database.

use atuin_client::history::History;

// this will not compile because `id` field is missing
let history: History = History::from_db()
    .timestamp(time::OffsetDateTime::now_utc())
    .command("ls -la".to_string())
    .cwd("/home/user".to_string())
    .exit(0)
    .duration(100)
    .session("somesession".to_string())
    .hostname("localhost".to_string())
    .deleted_at(None)
    .build()
    .into();

pub fn success(&self) -> bool

pub fn should_save(&self, settings: &Settings) -> bool

Trait Implementations

impl Clone for History

fn clone(&self) -> History

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for History

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

Formats the value using the given formatter.

impl From<HistDbEntry> for History

fn from(histdb_item: HistDbEntry) -> Self

Converts to this type from the input type.

impl<'a, R: Row> FromRow<'a, R> for History

where &'a str: ColumnIndex<R>, HistoryId: Decode<'a, R::Database> + Type<R::Database>, OffsetDateTime: Decode<'a, R::Database> + Type<R::Database>, i64: Decode<'a, R::Database> + Type<R::Database>, String: Decode<'a, R::Database> + Type<R::Database>, Option<OffsetDateTime>: Decode<'a, R::Database> + Type<R::Database>,

fn from_row(__row: &'a R) -> Result<Self>

impl PartialEq for History

fn eq(&self, other: &History) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for History

impl StructuralPartialEq for History