Struct AsciiCast

pub struct AsciiCast<'a> { /* private fields */ }

An asciicast v2 file.

Creation

Can be created using the AsciiCast::new method, which accepts a writer and returns an empty asciicast without any events. To modify header and write events to an asciicast, you can call respective methods (see “Header” and “Events” section).

Modification

Header

You can modify the header of the asciicast using the following methods:

• width: Set the initial terminal width.
• height: Set the initial terminal height.
• timestamp: Set the unix timestamp of the beginning of the recording session.
• idle_time_limit: Set the idle time limit.
• title: Set the title of the asciicast.

After you’ve finished, write the header to the asciicast using the write_header method explicitly. If you don’t, the header will be written implicitly when you write the first event. Note that the header can only be written once, either explicitly or implicitly.

Events

You can add events to the asciicast using the following methods:

• output: Add an output event to the asciicast.
• input: Add an input event to the asciicast.
• marker: Add a marker event to the asciicast.
• resize: Add a resize event to the asciicast.

Output

The asciicast will be streamed to the writer you provided, every time you add an event or write the header.

Implementations

impl<'a> AsciiCast<'a>

pub fn new(writer: &'a mut dyn Write) -> Self

Create a new asciicast.

pub fn width(&mut self, width: u16) -> Result<&mut Self, ErrorType>

Set the initial terminal width.

pub fn height(&mut self, height: u16) -> Result<&mut Self, ErrorType>

Set the initial terminal height.

pub fn timestamp(&mut self, timestamp: u64) -> Result<&mut Self, ErrorType>

Set the unix timestamp of the beginning of the recording session.

pub fn idle_time_limit( &mut self, idle_time_limit: f64, ) -> Result<&mut Self, ErrorType>

Set the idle time limit.

pub fn title(&mut self, title: String) -> Result<&mut Self, ErrorType>

Set the title of the asciicast.

pub fn write_header(&mut self) -> Result<&mut Self, ErrorType>

Write the header to the writer.

pub fn output(&mut self, time: u64, data: &str) -> Result<&mut Self, ErrorType>

Write an output event to the asciicast.

pub fn input(&mut self, time: u64, data: &str) -> Result<&mut Self, ErrorType>

Write an input event to the asciicast.

pub fn marker(&mut self, time: u64, name: &str) -> Result<&mut Self, ErrorType>

Write a marker event to the asciicast.

pub fn resize( &mut self, time: u64, columns: u16, rows: u16, ) -> Result<&mut Self, ErrorType>

Write a resize event to the asciicast.