bbx 0.3.1

A robust, performant BBCode pull parser.
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

//! Robust and performant BBCode pull parser.
//! # Examples
//! ## Simple parsing
//! ```rust
//! # use bbx::BBParser;
//! # const input: &str = "This would be lorem ipsum [b]but doing so is kind of unnecessary[/b]";
//! let mut parser = BBParser::new(/* &str */ input);
//!
//! for token in parser {
//!     println!("{:?}", token);
//! }
//! ```
#![cfg_attr(
    feature = "html_gen",
    doc = r#"## Built-in sanitized HTML output
```rust
# use bbx::{BBParser, html::{*, builtins::*}};
# const input: &str = "[title]This is a test document![/title]";
// Simple serializer default with all of the v1.0.0 tags considered "core" to the library.
let mut serializer: HtmlSerializer<SimpleHtmlWriter> =
    HtmlSerializer::with_tags(all_core_v1_tags());
let mut parser = BBParser::new(input);
println!("Document:");
println!("{}", serializer.serialize(parser));
```"#
)]
//! # `no_std`
#![cfg_attr(
    not(feature = "alloc"),
    doc = "This feature set is `no_std` compatible, should you want that."
)]
#![cfg_attr(
    all(feature = "alloc", not(feature = "html_gen")),
    doc = "This feature set is not `no_std` compatible but is `alloc` compatible, due to the following features:"
)]
#![cfg_attr(
    all(feature = "alloc", feature = "html_gen"),
    doc = "This feature set is `std` (hosted) only, due to the following features:"
)]
#![cfg_attr(feature = "track_open_tags", doc = "- `track_open_tags`")]
#![cfg_attr(feature = "parser_rules", doc = "- `parser_rules`")]
#![cfg_attr(feature = "html_gen", doc = "- `html_gen` (required `std`!)")]
#![cfg_attr(not(all(feature = "alloc", feature = "html_gen")), no_std)]
#![cfg_attr(coverage_nightly, feature(coverage_attribute))]

extern crate alloc;

mod parser;

pub use parser::{BBParser, BBTag, ParserConfig, ParserFeature, Token, TokenKind};

#[cfg(feature = "parser_rules")]
pub use parser::rules;

#[cfg(feature = "html_gen")]
pub mod html;