Struct reedline::HistoryItem

pub struct HistoryItem<ExtraInfo: HistoryItemExtraInfo = IgnoreAllExtraInfo> {
    pub id: Option<HistoryItemId>,
    pub start_timestamp: Option<DateTime<Utc>>,
    pub command_line: String,
    pub session_id: Option<HistorySessionId>,
    pub hostname: Option<String>,
    pub cwd: Option<String>,
    pub duration: Option<Duration>,
    pub exit_status: Option<i64>,
    pub more_info: Option<ExtraInfo>,
}

Represents one run command with some optional additional context

Fields

id: Option<HistoryItemId>

primary key, unique across one history

start_timestamp: Option<DateTime<Utc>>

date-time when this command was started

command_line: String

the full command line as text

session_id: Option<HistorySessionId>

a unique id for one shell session. used so the history can be filtered to a single session

hostname: Option<String>

the hostname the commands were run in

cwd: Option<String>

the current working directory

duration: Option<Duration>

the duration the command took to complete

exit_status: Option<i64>

the exit status of the command

more_info: Option<ExtraInfo>

arbitrary additional information that might be interesting NOTE: this attribute is required because of https://github.com/rust-lang/rust/issues/41617 (see https://github.com/serde-rs/serde/issues/1296#issuecomment-394056188 for the fix)

Implementations

impl HistoryItem

pub fn from_command_line(cmd: impl Into<String>) -> HistoryItem

create a history item purely from the command line with everything else set to None

Trait Implementations

impl<ExtraInfo: Clone + HistoryItemExtraInfo> Clone for HistoryItem<ExtraInfo>

fn clone(&self) -> HistoryItem<ExtraInfo>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<ExtraInfo: Debug + HistoryItemExtraInfo> Debug for HistoryItem<ExtraInfo>

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

Formats the value using the given formatter.

impl<'de, ExtraInfo: HistoryItemExtraInfo> Deserialize<'de> for HistoryItem<ExtraInfo>

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<ExtraInfo: PartialEq + HistoryItemExtraInfo> PartialEq for HistoryItem<ExtraInfo>

fn eq(&self, other: &HistoryItem<ExtraInfo>) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

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

impl<ExtraInfo> Serialize for HistoryItem<ExtraInfo>

where ExtraInfo: Serialize + HistoryItemExtraInfo,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<ExtraInfo: Eq + HistoryItemExtraInfo> Eq for HistoryItem<ExtraInfo>

impl<ExtraInfo: HistoryItemExtraInfo> StructuralPartialEq for HistoryItem<ExtraInfo>