unobtanium_text_pile/lib.rs
1// SPDX-FileCopyrightText: 2025 Slatian
2//
3// SPDX-License-Identifier: LGPL-3.0-only
4
5#![doc = include_str!("../README.md")]
6//! ## Where to start
7//!
8//! To get started have a look at the [`TextPileBuilder`][text_pile::TextPileBuilder] and [`TextPile`][text_pile::TextPile] types.
9//!
10//! ## Feature Flags
11//!
12//! * `digest`: Will add a hashing function to the [TextPile][text_pile::TextPile] and [SerializableTextPile][text_pile::SerializableTextPile].
13//! * `rusqlite`: Will add database serialization and deserialization capabilities to the digest output and the [DehydratedTextPileMetadata][text_pile::DehydratedTextPileMetadata].
14//! * `scraper`: Adds HTML parsing capabilities to the [TextPileBuilder][text_pile::TextPileBuilder] using the `scraper` crate.
15//! * `full`: Convenience feature to enable all other features, useful for running tests.
16
17#![warn(missing_docs)]
18#![deny(unsafe_code)]
19
20pub mod html;
21pub mod language_tag;
22pub mod marker;
23pub mod segmented_text_pile;
24pub mod text_pile;
25
26pub(crate) mod debug;