Skip to main content

facet_value/
lib.rs

1//! `facet-value` provides a memory-efficient dynamic value type for representing
2//! structured data similar to JSON, but with added support for binary data and datetime.
3//!
4//! # Features
5//!
6//! - **Pointer-sized `Value` type**: The main `Value` type is exactly one pointer in size
7//! - **Eight value types**: Null, Bool, Number, String, Bytes, Array, Object, DateTime
8//! - **`no_std` compatible**: Works with just `alloc`, no standard library required
9//! - **Bytes support**: First-class support for binary data (useful for MessagePack, CBOR, etc.)
10//! - **DateTime support**: First-class support for temporal data (useful for TOML, YAML, etc.)
11//!
12//! # Design
13//!
14//! `Value` uses a tagged pointer representation with 8-byte alignment, giving us 3 tag bits
15//! to distinguish between value types. Inline values (null, true, false) don't require
16//! heap allocation.
17
18#![cfg_attr(not(feature = "std"), no_std)]
19#![warn(missing_docs)]
20#![warn(clippy::std_instead_of_core)]
21#![warn(clippy::std_instead_of_alloc)]
22
23#[cfg(feature = "alloc")]
24extern crate alloc;
25
26#[cfg(feature = "alloc")]
27mod macros;
28
29mod value;
30pub use value::*;
31
32mod number;
33pub use number::*;
34
35mod string;
36pub use string::*;
37
38mod bytes;
39pub use bytes::*;
40
41mod array;
42pub use array::*;
43
44mod object;
45pub use object::*;
46
47mod datetime;
48pub use datetime::*;
49
50mod serialize;
51pub use serialize::*;
52
53mod other;
54pub use other::{OtherKind, VQName, VUuid};
55
56#[cfg(feature = "alloc")]
57mod facet_impl;
58#[cfg(feature = "alloc")]
59pub use facet_impl::VALUE_SHAPE;
60
61#[cfg(feature = "alloc")]
62mod deserialize;
63#[cfg(feature = "alloc")]
64pub use deserialize::{PathSegment, ValueError, ValueErrorKind, from_value};
65
66#[cfg(feature = "alloc")]
67mod format;
68#[cfg(feature = "alloc")]
69pub use format::{FormattedValue, format_value, format_value_with_spans};
70
71#[cfg(all(test, feature = "alloc"))]
72mod inline_roundtrip_tests;