tephra-types 0.1.3

Shared vocabulary types for tephra: positions, event type/tag names, and the query model. Pure data and validation, no I/O.
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

//! Shared vocabulary for tephra: the concepts a client and the storage engine both speak.
//!
//! This crate is pure data and validation with no I/O and no storage machinery, so a
//! client can link it (and the wire protocol) without pulling in the engine. It holds the
//! [`Position`] type, the event [`EventType`]/[`Tag`] names and the sorted [`Tags`] set,
//! and the [`Query`] model ([`Query`], [`QueryItem`], [`AppendCondition`]).
//!
//! The engine re-exports these types, so `tephra::Query` and [`tephra_types::Query`](Query)
//! are the same type. Name and tag validation ([`EventType::new`], [`Tag::new`],
//! [`Tags::new`]) lives here as the single source of truth for both sides.

pub mod name;
pub mod position;
pub mod query;

pub use name::{EventType, MAX_NAME_LEN, NameError, Tag, Tags, TagsError};
pub use position::Position;
pub use query::{AppendCondition, Query, QueryItem};

/// The README, compiled as a doctest so its code samples cannot drift from the API. Present
/// only during doctest builds (`cfg(doctest)`), so it never appears in the published docs.
#[cfg(doctest)]
#[doc = include_str!("../README.md")]
struct CrateReadme;