cirious_codex_term 0.2.1

Next-generation native ANSI terminal control and formatting.
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

//! # Cirious Codex Term
//!
//! A high-performance, zero-allocation terminal styling and manipulation library
//! designed as the foundational bedrock for the Cirious ecosystem.
//!
//! This crate provides an intuitive and elegant API for ANSI terminal colors,
//! text styles, cursor movement, and screen clearing.
//!
//! ## Quick Start
//!
//! Simply import the `StyleExt` trait to seamlessly style any type that
//! implements `std::fmt::Display`.
//!
//! ```rust
//! use cirious_codex_term::StyleExt;
//!
//! // Style strings natively
//! println!("{}", "Warning: High memory usage!".yellow().bold().blink());
//!
//! // Style any type seamlessly
//! let age = 25;
//! println!("You are {} years old.", age.green().underline());
//! ```

// Enables docs.rs features to show tags like "Only on Windows"
#![cfg_attr(docsrs, feature(doc_cfg))]
// Ensures all public items are documented (Essential for crates.io)
#![warn(missing_docs)]
// Prevents accidental unsafe code in the entire crate
#![deny(unsafe_code)]

/// ANSI control structures (Colors, Styles, Cursor, and Screen).
pub mod control;

/// Terminal lifecycle and environment utilities.
pub mod prompt;

/// Asynchronous terminal event handling (Keyboard, Mouse).
pub mod event;

// -----------------------------------------------------------------------------
// PUBLIC API EXPORTS
// -----------------------------------------------------------------------------

// Styling & Control
pub use control::{Color, Cursor, Screen, Style, StyleExt, StyledText};

// Events
pub use event::{poll, read, Event, KeyCode, KeyEvent};

// Terminal Lifecycle
pub use prompt::{init_term, RawModeGuard, TerminalSize};

// Windows-specific utilities
#[cfg(windows)]
pub use prompt::enable_ansi_support;