cesr-rs 0.8.0

CESR + KERI primitives for Rust as a single feature-gated, no_std-capable crate
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
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107

//! CESR + KERI primitives for Rust as a single feature-gated crate.
//!
//! Each former separate crate is now a module gated by a cargo feature:
//! `b64`, `core`, `crypto`, `stream`, `keri`, `serder`, reachable as
//! `cesr::core::*`, `cesr::crypto::*`, etc. (The former `utils` module — the
//! CESR Base64 codec — is now `b64`.)
//!
//! The crate is `no_std`-capable: `std` (on by default) gives the std-backed
//! surface; build `--no-default-features --features alloc,…` for embedded/wasm.
#![no_std]
#![cfg_attr(docsrs, feature(doc_cfg))]

#[cfg(feature = "alloc")]
extern crate alloc;

#[cfg(feature = "std")]
extern crate std;

#[cfg(feature = "b64")]
pub mod b64;
#[cfg(feature = "core")]
pub mod core;
#[cfg(feature = "crypto")]
pub mod crypto;
#[cfg(feature = "keri")]
pub mod keri;
#[cfg(feature = "serder")]
pub mod serder;
#[cfg(feature = "stream")]
pub mod stream;

#[cfg(feature = "core")]
#[doc(inline)]
pub use core::{
    Cigar, Dater, Diger, Labeler, Matter, Noncer, Number, Prefixer, Saider, Seqner, Siger, Signer,
    Texter, Tholder, Verfer, Verser,
};
#[cfg(feature = "crypto")]
#[doc(inline)]
pub use crypto::{Algorithm, Ed25519, KeyPair, Secp256k1, Secp256r1};
#[cfg(feature = "keri")]
#[doc(inline)]
pub use keri::{Identifier, Ilk, KeriError, KeriEvent, Role, Seal};
#[cfg(feature = "serder")]
#[doc(inline)]
pub use serder::{
    InceptionBuilder, InteractionBuilder, KeriDeserialize, KeriSerialize, RotationBuilder,
    SerderError,
};
#[cfg(all(feature = "stream", feature = "async"))]
#[doc(inline)]
pub use stream::CesrCodec;
#[cfg(feature = "stream")]
#[doc(inline)]
pub use stream::{
    CesrEncode, CesrGroup, CesrMessage, ColdCode, Groups, GroupsV2, ParseError, Tritet, V1, V2,
};

// Collision: core keeps the bare `CesrVersion`; stream's is module-prefixed.
// core::CesrVersion is stream-gated, so guard the bare export on both features.
#[cfg(all(feature = "core", feature = "stream"))]
#[doc(inline)]
pub use core::CesrVersion;
#[cfg(feature = "stream")]
#[doc(inline)]
pub use stream::CesrVersion as StreamCesrVersion;

/// The common imports for working with `cesr`.
///
/// `use cesr::prelude::*;` brings the traits you need in scope for method
/// resolution, plus a handful of headliner types so you can write code from the
/// glob alone. Every other public type is reachable at the crate root
/// (`cesr::Matter`) or its module path (`cesr::core::Matter`).
pub mod prelude {
    // Traits — the primary payload (needed implicitly for method resolution).
    #[cfg(feature = "crypto")]
    #[doc(no_inline)]
    pub use crate::crypto::Algorithm;
    #[cfg(feature = "keri")]
    #[doc(no_inline)]
    pub use crate::keri::ConfigTrait;
    #[cfg(feature = "serder")]
    #[doc(no_inline)]
    pub use crate::serder::{KeriDeserialize, KeriSerialize};
    #[cfg(feature = "stream")]
    #[doc(no_inline)]
    pub use crate::stream::CesrEncode;

    // Headliner types — enough to write code from the glob alone.
    #[cfg(feature = "core")]
    #[doc(no_inline)]
    pub use crate::core::{Diger, Matter, Signer, Verfer};
    #[cfg(feature = "keri")]
    #[doc(no_inline)]
    pub use crate::keri::{Identifier, KeriEvent};
    #[cfg(feature = "stream")]
    #[doc(no_inline)]
    pub use crate::stream::{CesrGroup, CesrMessage};
}

#[cfg(test)]
#[cfg(all(feature = "serder", feature = "std"))]
mod keripy_diff;

#[cfg(test)]
#[cfg(all(feature = "serder", feature = "std"))]
mod keripy_parity;