[go: up one dir, main page]

comfy-table 7.1.3

An easy to use library for building beautiful tables with automatic content wrapping
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

#[cfg(all(feature = "tty", not(feature = "reexport_crossterm")))]
mod attribute;
mod cell;
#[cfg(all(feature = "tty", not(feature = "reexport_crossterm")))]
mod color;
mod column;
/// Contains modifiers, that can be used to alter certain parts of a preset.\
/// For instance, the [UTF8_ROUND_CORNERS](modifiers::UTF8_ROUND_CORNERS) replaces all corners with round UTF8 box corners.
pub mod modifiers;
/// This module provides styling presets for tables.\
/// Every preset has an example preview.
pub mod presets;
mod table;

pub use cell::CellAlignment;
pub use column::{ColumnConstraint, Width};
#[cfg(feature = "tty")]
pub(crate) use styling_enums::{map_attribute, map_color};
#[cfg(feature = "tty")]
pub use styling_enums::{Attribute, Color};
pub use table::{ContentArrangement, TableComponent};

/// Convenience module to have cleaner and "identical" conditional re-exports for style enums.
#[cfg(all(feature = "tty", not(feature = "reexport_crossterm")))]
mod styling_enums {
    pub use super::attribute::*;
    pub use super::color::*;
}

/// Re-export the crossterm type directly instead of using the internal mirrored types.
/// This result in possible ABI incompatibilities when using comfy_table and crossterm in the same
/// project with different versions, but may also be very convenient for developers.
#[cfg(all(feature = "tty", feature = "reexport_crossterm"))]
mod styling_enums {
    /// Attributes used for styling cell content. Reexport of crossterm's [Attributes](crossterm::style::Attribute) enum.
    pub use crossterm::style::Attribute;
    /// Colors used for styling cell content. Reexport of crossterm's [Color](crossterm::style::Color) enum.
    pub use crossterm::style::Color;

    /// Convenience function to have the same mapping code for reexported types.
    #[inline]
    pub(crate) fn map_attribute(attribute: Attribute) -> Attribute {
        attribute
    }

    /// Convenience function to have the same mapping code for reexported types.
    #[inline]
    pub(crate) fn map_color(color: Color) -> Color {
        color
    }
}