legneato / asciicast-rs

Rust library for the Asciicast file format used by Asciinema

asciicast

A Rust library for working with the Asciicast file format. Asciicast is used by Asciinema to play back terminal recordings.

Installation

asciicast is available on crates.io and can be included in your Cargo enabled project like this:

[dependencies]
asciicast = "0.2.2"

Then include it in your code like this:

extern crate asciicast;

Usage

This library exports version 2 of the asciicast format by default. Version 1 will eventually be available as a subcrate.

Api documentation.

Example (v2)

extern crate asciicast;

let entry = asciicast::Entry {
    time: 1.234,
    event_type: asciicast::EventType::Output,
    event_data: String::new("text data"),
};

println!("{:?}", entry);

License

asciicast is licensed under either of the following, at your option:

• Apache License, Version 2.0, (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
• MIT License (LICENSE-MIT or http://opensource.org/licenses/MIT)

asciicast-rs's Issues

What is the status of this crate?

Hi,

I was wondering what the status of this crate is? It looks like there hasn't been a commit since August of 2021 so I'm wondering if it's still maintained.

I'm starting a project to port svg-term to Rust and I'm looking at asciicast-rs as a library to depend on!

Cheers

Test on Windows and macOS

Currently Travis is only running on Linux.

Add builders for types

Add builders for types will let us hide implementation details of the structs.

Add the concept of an Asciicast session

Add a higher-level concept of an Asciicast session. This would keep track of timing and such. API might look something like:

let mut session = asciicast::Session::new(asciicast::v2);
session.set_height(42);
session.set_width(42);
session.add_event(asciicast::EventType::Input, String::new("this is an event");
session.add_event(asciicast::EventType::Output, String::new("whatever");
let completed = session.end();

It might be cool to have the session provide a stream as well.

Document optional features

Currently chrono is optional but on by default. We should document how to turn it off and what it changes.