tokel-std 0.1.1

A standard library of built-in TokenStream transformers for the Tokel engine.
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

#![forbid(
    clippy::all,
    clippy::perf,
    clippy::nursery,
    clippy::unwrap_used,
    clippy::panic,
    clippy::pedantic,
    rustdoc::all,
    unsafe_code
)]
//! # `tokel-std`
//!
//! `tokel-std` is a crate exposing a set of minimal, easily-composable transformer implementations that are deemed standard.
//!
//! ---
//!
//! *The following is the main `tokel` workspace documentation:*
//!
#![doc = include_str!("../README.md")]

use tokel_engine::prelude::{Registry, Transformer};

pub mod string;

pub mod iter;

pub mod structure;

pub mod state;

/// Register all the standard [`Transformer`] implementations
///
/// # Errors
///
/// This will fail if at least one standard [`Transformer`] is already present by-name in the [`Registry`].
///
/// On failure, there is no guarantee that other non-colliding transformers have not been registered.
#[inline]
pub fn register(registry: &mut Registry) -> Result<(), Box<dyn Transformer>> {
    string::register(registry)?;

    iter::register(registry)?;

    structure::register(registry)?;

    state::register(registry)?;

    Ok(())
}