Skip to main content

Columns

Struct Columns 

Source
pub struct Columns<'a> { /* private fields */ }
Expand description

A renderable that arranges items in columns.

Implementations§

Source§

impl<'a> Columns<'a>

Source

pub fn new(items: Vec<Vec<Segment<'a>>>) -> Self

Create a new Columns layout with the given items.

Source

pub fn from_strings(items: &[&'a str]) -> Self

Create columns from strings.

Source

pub fn column_count(self, count: usize) -> Self

Set the number of columns.

Source

pub fn gutter(self, gutter: usize) -> Self

Set the gutter (space between columns).

Source

pub fn expand(self, expand: bool) -> Self

Set whether to expand columns to fill width.

Source

pub fn equal_width(self, equal: bool) -> Self

Set whether columns should have equal width.

Source

pub fn align(self, align: AlignMethod) -> Self

Set alignment within columns.

Source

pub fn padding(self, padding: usize) -> Self

Set padding around each item.

Source

pub fn gutter_style(self, style: Style) -> Self

Set the gutter style.

Source

pub fn max_width(self, width: usize) -> Self

Set a maximum width for the columns layout.

When set, the columns will not expand beyond this width even if more terminal space is available. This prevents excessive whitespace on very wide terminals (e.g., 300+ columns).

§Example
let cols = Columns::from_strings(&["A", "B", "C"])
    .max_width(120)  // Never wider than 120 columns
    .expand(true);   // But expand up to that limit
Source

pub fn render(&self, total_width: usize) -> Vec<Vec<Segment<'a>>>

Render the columns to lines of segments.

Source

pub fn render_flat(&self, total_width: usize) -> Vec<Segment<'a>>

Render to a single flat list of segments with newlines.

Trait Implementations§

Source§

impl<'a> Clone for Columns<'a>

Source§

fn clone(&self) -> Columns<'a>

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl<'a> Debug for Columns<'a>

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for Columns<'_>

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Renderable for Columns<'_>

Source§

fn render<'b>( &'b self, _console: &Console, options: &ConsoleOptions, ) -> Vec<Segment<'b>>

Render the object to a list of segments.

Auto Trait Implementations§

§

impl<'a> Freeze for Columns<'a>

§

impl<'a> RefUnwindSafe for Columns<'a>

§

impl<'a> Send for Columns<'a>

§

impl<'a> Sync for Columns<'a>

§

impl<'a> Unpin for Columns<'a>

§

impl<'a> UnsafeUnpin for Columns<'a>

§

impl<'a> UnwindSafe for Columns<'a>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.