farben 0.20.0

Markup for the Terminal, but safer and faster.
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
57
58
59
60
61

/*
 * Copyright (c) 2026 RazkarStudio
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at https://mozilla.org/MPL/2.0/.
 */

//! # The Farben Prelude
//! The recommended way to bring Farben's public API into scope.
//!
//! Prefer `use farben::prelude::*` over `use farben::*`. The raw glob import
//! pulls in internal items (`color_runtime`, `validate_color`) that are `pub`
//! only to satisfy macro expansion requirements. This prelude exports only the
//! intentional public surface, gated by the same feature flags as their
//! definitions.
//!
//! # Usage
//!
//! ```rust
//! use farben::prelude::*;
//!
//! cprintln!("[bold green]Done![/] All tests passed.");
//! ```
//!
//! # What is included
//!
//! | Item | Condition |
//! |------|-----------|
//! | [`cstr`] | always |
//! | [`LexError`] | always |
//! | [`cformat!`], [`cformatb!`], [`cprint!`], [`cprintln!`], [`cprintb!`], [`cprintbln!`] | always |
//! | [`cwrite!`], [`cwriteln!`], [`cwriteb!`], [`cwritebln!`] | always |
//! | [`ceprint!`], [`ceprintln!`], [`ceprintb!`], [`ceprintbln!`] | always |
//! | [`unansi!`], [`unmarkup!`], [`untag!`] | always |
//! | [`expand!`] | always |
//! | [`style!`], [`prefix!`] | `format` feature |

pub use farben_core::errors::LexError;

#[allow(deprecated)]
pub use crate::color_fmt;

pub use crate::{
    cformat, cformatb, cprint, cprintb, cprintbln, cprintln, cstr, cwrite, cwriteb, cwritebln,
    cwriteln,
};

pub use crate::{ceprint, ceprintb, ceprintbln, ceprintln};

pub use crate::expand;

pub use crate::{unansi, unmarkup, untag};

#[cfg(feature = "format")]
pub use crate::{prefix, style};

#[allow(deprecated)]
#[cfg(any(feature = "markdown", feature = "markdown-compile"))]
#[deprecated = "use the `inline` feature, it works with the `c*` family. will be deleted at 0.19 stable"]
pub use crate::{md_fmt, mdeprint, mdeprintln, mdprint, mdprintln};