README.md

cable

An experimental cable protocol implementation in Rust.

Status: alpha (under active construction; expect changes).

This library provides a means of encoding and decoding binary payloads corresponding to all cable post and message types. Constructor methods are exposed for each type.

See the cable_core crate for higher-level client building types and methods.

Example

See cable/examples/types.rs for a complete set of examples.

Encode and decode a post:

use cable::post::Post;

// Create a new text post.
let mut text_post = Post::text(
    public_key,
    links,
    timestamp,
    channel,
    text,
);

// Sign the post.
text_post.sign(&secret_key)?;

// Encode the post to bytes.
let text_post_bytes = text_post.to_bytes()?;

// Decode the post from bytes.
let decoded_text_post = Post::from_bytes(&text_post_bytes)?;

// Display the post.
println!("{decoded_text_post}");

Encode and decode a message:

use cable::message::Message;

// Create a new post request message.
let mut post_request = Message::post_request(circuit_id, req_id, ttl, post_hashes);

// Encode the message to bytes.
let post_request_bytes = post_request.to_bytes()?;

// Decode the message from bytes.
let decoded_post_request = Message::from_bytes(&post_request_bytes)?;

// Display the message.
println!("{decoded_post_request}");

Documentation

Compile the documentation and open it in a browser:

cargo doc --open

Additional documentation can be found as code comments in the source.

Tests

Run the test suite:

cargo test