axsys-noun 0.1.2

A library for working with Noun data
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

//! This library provides a batteries-included [noun] implementation, [Urbit]'s native data
//! structure.
//!
//! # Thread Safety
//!
//! By default, this library uses [`std::rc::Rc`] as its reference-counting pointer, which is not
//! thread-safe. To use this library in a multi-threaded context, enable the `thread-safe` feature,
//! which will use [`std::sync::Arc`], a thread-safe reference-counting pointer, instead of
//! [`std::rc::Rc`].
//!
//! [Urbit]: https://urbit.org
//! [noun]: https://urbit.org/docs/glossary/noun

#[doc(hidden)]
pub mod atom;
#[doc(hidden)]
pub mod cell;
pub mod convert;
pub mod marker;
#[doc(hidden)]
pub mod noun;
pub mod serdes;

#[doc(hidden)]
#[cfg(feature = "hoon")]
pub mod hoon;

pub mod sept;

#[doc(inline)]
pub use crate::atom::{Atom, Builder as AtomBuilder, Iter as AtomIter};
#[doc(inline)]
pub use crate::cell::*;
#[doc(inline)]
pub use crate::noun::*;

/// A reference-counting pointer.
///
/// Alias for [`std::rc::Rc`] when `thread-safe` feature is disabled.
#[cfg(not(feature = "thread-safe"))]
pub type Rc<T> = std::rc::Rc<T>;

/// A reference-counting pointer.
///
/// Alias for [`std::sync::Arc`] when `thread-safe` feature is enabled.
#[cfg(feature = "thread-safe")]
pub type Rc<T> = std::sync::Arc<T>;