homestar_invocation/
lib.rs

1#![cfg_attr(docsrs, feature(doc_cfg))]
2#![warn(missing_debug_implementations, missing_docs, rust_2018_idioms)]
3#![deny(unreachable_pub)]
4
5//! `homestar-invocation` is an underlying foundation for Homestar
6//! packages, implementing much of the [Ucan Invocation]
7//! specification, among other useful library features.
8//!
9//! ## Related crates/packages:
10//!
11//! - [homestar-runtime]
12//! - [homestar-wasm]
13//! - [homestar-workflow]
14//!
15//! ## Getting Started
16//!
17//! For getting started with Homestar in general, please check out our
18//! [README] and [Quickstart] guide.
19//!
20//! ## Feature flags
21//!
22//! - `diesel`: Enables diesel-sqlite implementations of data structures.
23//! - `test-utils`: Enables utilities for unit testing and benchmarking.
24//!
25//! [homestar-runtime]: https://docs.rs/homestar-runtime
26//! [homestar-wasm]: https://docs.rs/homestar-wasm
27//! [homestar-workflow]: https://docs.rs/homestar-workflow
28//! [IPVM]: https://github.com/ipvm-wg
29//! [Quickstart]: https://github.com/ipvm-wg/homestar/blob/main/README.md#quickstart
30//! [README]: https://github.com/ipvm-wg/homestar/blob/main/README.md
31//! [Ucan invocation]: https://github.com/ucan-wg/invocation
32
33pub mod authority;
34pub mod consts;
35pub mod error;
36mod invocation;
37pub mod ipld;
38pub mod macros;
39pub mod pointer;
40pub mod receipt;
41pub mod task;
42#[cfg(any(test, feature = "test-utils"))]
43#[cfg_attr(docsrs, doc(cfg(feature = "test-utils")))]
44pub mod test_utils;
45pub mod unit;
46
47pub use consts::*;
48pub use error::Error;
49pub use invocation::Invocation;
50pub use pointer::Pointer;
51pub use receipt::Receipt;
52pub use task::Task;
53pub use unit::*;
homestar_invocation/lib.rs

homestar_invocation/
lib.rs
