typebox 0.1.0

JSON Schema type construction with validation, code generation, and binary layout
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

#![recursion_limit = "1024"]

//! JSON Schema type construction with validation, code generation, and binary layout.
//!
//! Inspired by [TypeBox](https://github.com/sinclairzx81/typebox) (TypeScript).
//!
//! # Example
//!
//! ```
//! use typebox::{SchemaBuilder, Value, check, create};
//!
//! // Define a schema
//! let person = SchemaBuilder::object()
//!     .field("id", SchemaBuilder::int64())
//!     .field("name", SchemaBuilder::string().build())
//!     .optional_field("email", SchemaBuilder::string().build())
//!     .named("Person");
//!
//! // Create a default value
//! let value = create(&person).unwrap();
//! assert!(check(&person, &value));
//!
//! // Build values manually
//! let alice = Value::object()
//!     .field("id", Value::Int64(1))
//!     .field("name", Value::String("Alice".to_string()))
//!     .build();
//! assert!(check(&person, &alice));
//! ```
//!
//! # Feature Flags
//!
//! - `codegen` - Generate Rust/TypeScript code from schemas
//! - `fake` - Generate random test data (requires `fake` and `rand` crates)
//! - `safetensor` - SafeTensor file support
//! - `ffi` - C-compatible FFI types

pub mod builder;
pub mod error;
pub mod format;
pub mod layout;
pub mod registry;
pub mod schema;
pub mod validate;
pub mod value;

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

pub use builder::SchemaBuilder;
pub use error::{CastError, CleanError, CreateError, Error, PatchError};
pub use format::{FormatRegistry, FormatValidator};
pub use layout::Layout;
pub use registry::SchemaRegistry;
pub use schema::{LiteralValue, Schema, SchemaKind, StringFormat};
pub use validate::{validate, validate_with_format, validate_with_registry};
pub use value::Value;
pub use value::{
    cast, check, check_with_errors, clean, clone, create, delta, diff_summary, equal, patch, Delta,
    Edit,
};

#[cfg(feature = "fake")]
pub use error::FakeError;
#[cfg(feature = "fake")]
pub use value::{fake, fake_with_context, FakeContext};

#[cfg(feature = "codegen")]
pub use codegen::{RustGenerator, TypeScriptGenerator};

/// Crate version string.
pub const VERSION: &str = env!("CARGO_PKG_VERSION");