Skip to main content

Transcript

Struct Transcript 

Source
pub struct Transcript { /* private fields */ }
Expand description

Per-pane line transcript bounded by the effective history-limit.

Implementations§

Source§

impl Transcript

Source

pub fn new(limit: usize) -> Self

Creates an empty transcript bounded to limit retained lines.

Source

pub const fn limit(&self) -> usize

Returns the current retained line limit.

Source

pub fn line_count(&self) -> usize

Returns the number of retained history lines.

Source

pub fn set_limit(&mut self, limit: usize)

Updates the retained line limit and evicts older lines if needed.

Source

pub fn append_line(&mut self, line: impl Into<String>)

Appends one complete logical line to the transcript.

Source

pub const fn lines(&self) -> &VecDeque<String>

Returns the retained lines ordered from oldest to newest.

Source

pub fn capture(&self, start: Option<i64>, end: Option<i64>) -> Vec<u8>

Captures an inclusive range of retained lines as newline-delimited bytes.

Non-negative bounds are zero-based indices into retained history. Negative bounds count backward from the newest line, where -1 is the newest retained line. Missing bounds mean the first or last retained line. Out-of-range values clamp to the retained transcript. Reversed ranges are swapped to match tmux’s buffer capture behavior.

Source

pub fn byte_size(&self) -> usize

Returns the retained history size in bytes including trailing newlines.

Trait Implementations§

Source§

impl Clone for Transcript

Source§

fn clone(&self) -> Transcript

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Transcript

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Transcript

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Eq for Transcript

Source§

impl PartialEq for Transcript

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Transcript

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.