ox_jsdoc 0.0.16

High-performance JSDoc parser with Binary AST format and lazy decoder, inspired by oxc
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

// @author kazuya kawaguchi (a.k.a. kazupon)
// @license MIT
//

//! Binary AST writer (parser-integrated, approach c-1).
//!
//! See `design/007-binary-ast/rust-impl.md#parser-integrated-binary-writer`
//! for the design rationale.
//!
//! The writer is invoked from inside the parser as it produces nodes. It
//! emits Binary AST bytes directly into an arena-backed buffer per section
//! ([`BinaryWriter`]), then concatenates them into the final `Vec<u8>` at
//! [`BinaryWriter::finish`]. There is no separate encoder pass; parsing
//! and encoding happen in lockstep.
//!
//! Per-Kind emit helpers live in [`nodes`]; the top-level orchestration
//! (section buffers, header patching, root array, diagnostics, UTF-16
//! position conversion via [`crate::utf16::Utf16PositionMap`]) lives in
//! [`BinaryWriter`].

mod binary_writer;
mod extended_data;
pub mod nodes;
mod string_table;

pub use crate::format::string_field::StringField;
pub use binary_writer::{BinaryWriter, ListInProgress};
pub use extended_data::{ExtOffset, ExtendedDataBuilder};
pub use nodes::NodeIndex;
pub use string_table::{
    COMMON_CRLF, COMMON_EMPTY, COMMON_LF, COMMON_SLASH_STAR, COMMON_SLASH_STAR_STAR, COMMON_SPACE,
    COMMON_STAR, COMMON_TAB, LeafStringPayload, StringIndex, StringTableBuilder,
    common_string_field,
};