twine_builder 0.1.3

Twine protocol rust library functionality for building Twine data structures
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24

# Twine Builder

[![Crates.io Version](https://img.shields.io/crates/v/twine_builder)](https://crates.io/crates/twine_builder)
[![docs.rs (with version)](https://img.shields.io/docsrs/twine_builder/latest)](https://docs.rs/twine_builder/latest/twine_builder/)

This crate contains functionality for creating Twine data structures. It can
be bundled and used from the [twine_protocol crate](https://crates.io/crates/twine_protocol) by enabling the `build` feature.

## Usage

Normal construction of twine data involves the following:

- Creating a [`Signer`] to sign data.
- Creating a [`TwineBuilder`] and providing it with the signer.
- Calling the build methods of the builder to construct data.
- Saving that data to some [`twine_lib::store::Store`].

See the documentation for specifics about the [`Signer`], [`TwineBuilder`],
and [`Store`](https://docs.rs/twine_lib/latest/twine_lib/store/trait.Store.html).

## Version 1 data

In order to construct version 1 data structures, the `v1` feature flag
must be enabled and a `BiscuitSigner` can be used.