paft-utils 0.9.0

Utility helpers shared across the paft workspace.
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

#![forbid(unsafe_code)]
#![warn(missing_docs)]

//! Shared utility helpers used across the paft workspace.
//!
//! This crate provides:
//! - Canonical string utilities (`Canonical`, `canonicalize`) for enum `Other` variants
//!   with a bounded stored-token length (`MAX_CANONICAL_TOKEN_LEN`)
//! - Optional dataframe helpers for converting domain structs to `polars` frames
//!
//! # Quickstart
//! ```rust
//! use paft_utils::{canonicalize, Canonical};
//!
//! // Normalize provider strings into canonical tokens
//! assert_eq!(canonicalize("Euronext Paris"), "EURONEXT_PARIS");
//!
//! // Validate non-empty canonical tokens via the `Canonical` wrapper
//! let c = Canonical::try_new("nasdaq").unwrap();
//! assert_eq!(c.as_str(), "NASDAQ");
//! ```
//!
//! # Feature flags
//! - `dataframe`: enable lightweight dataframe traits for `polars`

#[cfg(feature = "dataframe")]
pub mod dataframe;
pub mod string_canonical;

#[cfg(feature = "dataframe")]
pub use dataframe::{Columnar, Decimal128Encode, ToDataFrame, ToDataFrameVec};
pub use string_canonical::{
    Canonical, CanonicalError, MAX_CANONICAL_TOKEN_LEN, StringCode, canonicalize,
    has_canonical_token_boundaries,
};