https://github.com/legneato/asciicast-rs

Rust library for the Asciicast file format used by Asciinema
https://github.com/legneato/asciicast-rs

asciicast asciinema rust rust-library tty

Last synced: 16 days ago
JSON representation

Rust library for the Asciicast file format used by Asciinema

• Host: GitHub
• URL: https://github.com/legneato/asciicast-rs
• Owner: LegNeato
• License: apache-2.0
• Created: 2018-02-27T07:56:28.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2023-12-16T21:15:24.000Z (11 months ago)
• Last Synced: 2024-10-14T17:20:07.192Z (30 days ago)
• Topics: asciicast, asciinema, rust, rust-library, tty
• Language: Rust
• Size: 21.5 KB
• Stars: 5
• Watchers: 4
• Forks: 2
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE-APACHE

Awesome Lists containing this project

README

        
# [asciicast]

[![Build Status](https://travis-ci.org/LegNeato/asciicast-rs.svg?branch=master)](https://travis-ci.org/LegNeato/asciicast-rs)

A Rust library for working with the [Asciicast file format][versions].

Asciicast is used by [Asciinema][asciinema] to play back terminal

recordings.

### Installation

`asciicast` is available on [crates.io](https://crates.io/crates/asciicast) and can be included in your Cargo enabled project like this:

```toml

[dependencies]

asciicast = "0.2.2"

```

Then include it in your code like this:

```rust

extern crate asciicast;

```

### Usage

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

[Api documentation](https://docs.rs/asciicast).

#### Example (v2)

```rust

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](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)

* MIT License ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)

[asciicast]: https://github.com/LegNeato/asciicast-rs

[asciinema]: https://asciinema.org

[v1]: https://github.com/asciinema/asciinema/blob/develop/doc/asciicast-v1.md

[v2]: https://github.com/asciinema/asciinema/blob/develop/doc/asciicast-v2.md

[versions]: https://github.com/asciinema/asciinema/tree/develop/doc