Struct papergrid::config::spanned::SpannedConfig

pub struct SpannedConfig { /* private fields */ }

This structure represents a settings of a grid.

grid: crate::Grid.

Implementations

impl SpannedConfig

pub fn set_margin(&mut self, margin: Sides<Indent>)

Set a margin of a grid.

pub fn set_margin_color(&mut self, margin: Sides<Option<ANSIBuf>>)

Set a color of margin of a grid.

pub fn set_margin_offset(&mut self, margin: Sides<Offset>)

Set an offset of margin of a grid.

pub fn get_margin(&self) -> Sides<Indent>

Returns a margin value currently set.

pub fn get_margin_color(&self) -> Sides<Option<ANSIBuf>>

Returns a margin color value currently set.

pub fn get_margin_offset(&self) -> Sides<Offset>

Returns a margin offset value currently set.

pub fn remove_borders(&mut self)

Removes border changes.

pub fn remove_borders_colors(&mut self)

Removes border changes.

pub fn remove_color_line_horizontal(&mut self)

Removes border changes.

pub fn remove_color_line_vertical(&mut self)

Removes border changes.

pub fn remove_horizontal_chars(&mut self)

Removes border changes.

pub fn remove_vertical_chars(&mut self)

Removes border changes.

pub fn set_borders(&mut self, borders: Borders<char>)

Set the Borders value as correct one.

pub fn get_border_default(&self) -> Option<&char>

Gets a global border value if set.

pub fn set_border_default(&mut self, c: char)

Set the all Borders values to a char.

pub fn get_borders(&self) -> &Borders<char>

Returns a current Borders structure.

pub fn insert_horizontal_line(&mut self, line: usize, val: HorizontalLine<char>)

Set the border line by row index.

Row 0 means the top row. Row grid.count_rows() means the bottom row.

pub fn remove_horizontal_line(&mut self, line: usize, count_rows: usize)

Sets off the border line by row index if any were set

Row 0 means the top row. Row grid.count_rows() means the bottom row.

pub fn get_vertical_line(&self, line: usize) -> Option<&VerticalLine<char>>

Gets a overridden vertical line.

Row 0 means the left row. Row grid.count_columns() means the right most row.

pub fn get_vertical_lines(&self) -> HashMap<usize, VerticalLine<char>>

Gets all overridden vertical lines.

Row 0 means the top row. Row grid.count_rows() means the bottom row.

pub fn insert_vertical_line(&mut self, line: usize, val: VerticalLine<char>)

Set the border line by column index.

Row 0 means the left row. Row grid.count_columns() means the right most row.

pub fn remove_vertical_line(&mut self, line: usize, count_columns: usize)

Sets off the border line by column index if any were set

Row 0 means the left row. Row grid.count_columns() means the right most row.

pub fn get_horizontal_line(&self, line: usize) -> Option<&HorizontalLine<char>>

Gets a overridden line.

Row 0 means the top row. Row grid.count_rows() means the bottom row.

pub fn get_horizontal_lines(&self) -> HashMap<usize, HorizontalLine<char>>

Gets all overridden lines.

Row 0 means the top row. Row grid.count_rows() means the bottom row.

pub fn set_horizontal_char(&mut self, pos: Position, c: char, offset: Offset)

Override a character on a horizontal line.

If borders are not set the char won’t be used.

It takes not cell position but line as row and column of a cell; So its range is line <= count_rows && col < count_columns.

pub fn lookup_horizontal_char( &self, pos: Position, offset: usize, end: usize, ) -> Option<char>

Get a list of overridden chars in a horizontal border.

It takes not cell position but line as row and column of a cell; So its range is line <= count_rows && col < count_columns.

pub fn is_overridden_horizontal(&self, pos: Position) -> bool

Checks if there any char in a horizontal border being overridden.

It takes not cell position but line as row and column of a cell; So its range is line <= count_rows && col < count_columns.

pub fn remove_overridden_horizontal(&mut self, pos: Position)

Removes a list of overridden chars in a horizontal border.

It takes not cell position but line as row and column of a cell; So its range is line <= count_rows && col < count_columns.

pub fn set_vertical_char(&mut self, pos: Position, c: char, offset: Offset)

Override a vertical split line.

If borders are not set the char won’t be used.

It takes not cell position but cell row and column of a line; So its range is row < count_rows && col <= count_columns.

pub fn lookup_vertical_char( &self, pos: Position, offset: usize, end: usize, ) -> Option<char>

Get a list of overridden chars in a horizontal border.

It takes not cell position but cell row and column of a line; So its range is row < count_rows && col <= count_columns.

pub fn is_overridden_vertical(&self, pos: Position) -> bool

Checks if there any char in a horizontal border being overridden.

It takes not cell position but cell row and column of a line; So its range is row < count_rows && col <= count_columns.

pub fn remove_overridden_vertical(&mut self, pos: Position)

Removes a list of overridden chars in a horizontal border.

It takes not cell position but cell row and column of a line; So its range is row < count_rows && col <= count_columns.

pub fn set_horizontal_color( &mut self, pos: Position, c: ANSIBuf, offset: Offset, )

Override a character color on a horizontal line.

pub fn lookup_horizontal_color( &self, pos: Position, offset: usize, end: usize, ) -> Option<&ANSIBuf>

Get a overridden color in a horizontal border.

pub fn set_vertical_color(&mut self, pos: Position, c: ANSIBuf, offset: Offset)

Override a character color on a vertical line.

pub fn lookup_vertical_color( &self, pos: Position, offset: usize, end: usize, ) -> Option<&ANSIBuf>

Get a overridden color in a vertical border.

pub fn set_padding(&mut self, entity: Entity, padding: Sides<Indent>)

Set a padding to a given cells.

pub fn set_padding_color( &mut self, entity: Entity, padding: Sides<Option<ANSIBuf>>, )

Set a padding to a given cells.

pub fn get_padding(&self, entity: Entity) -> Sides<Indent>

Get a padding for a given Entity.

pub fn get_padding_color(&self, entity: Entity) -> Sides<Option<ANSIBuf>>

Get a padding color for a given Entity.

pub fn set_formatting(&mut self, entity: Entity, formatting: Formatting)

Set a formatting to a given cells.

pub fn get_formatting(&self, entity: Entity) -> &Formatting

Get a formatting settings for a given Entity.

pub fn set_alignment_vertical( &mut self, entity: Entity, alignment: AlignmentVertical, )

Set a vertical alignment to a given cells.

pub fn get_alignment_vertical(&self, entity: Entity) -> &AlignmentVertical

Get a vertical alignment for a given Entity.

pub fn set_alignment_horizontal( &mut self, entity: Entity, alignment: AlignmentHorizontal, )

Set a horizontal alignment to a given cells.

pub fn get_alignment_horizontal(&self, entity: Entity) -> &AlignmentHorizontal

Get a horizontal alignment for a given Entity.

pub fn set_border(&mut self, pos: Position, border: Border<char>)

Set border set a border value to all cells in Entity.

pub fn get_border(&self, pos: Position, shape: (usize, usize)) -> Border<char>

Returns a border of a cell.

pub fn get_border_color( &self, pos: Position, shape: (usize, usize), ) -> Border<&ANSIBuf>

Returns a border color of a cell.

pub fn set_borders_missing(&mut self, c: char)

Set a character which will be used in case any misconfiguration of borders.

It will be usde for example when you set a left char for border frame and top but didn’t set a top left corner.

pub fn get_borders_missing(&self) -> char

Get a character which will be used in case any misconfiguration of borders.

pub fn get_border_color_default(&self) -> Option<&ANSIBuf>

Gets a color of all borders on the grid.

pub fn set_border_color_default(&mut self, clr: ANSIBuf)

Sets a color of all borders on the grid.

pub fn get_color_borders(&self) -> &Borders<ANSIBuf>

Gets colors of a borders carcass on the grid.

pub fn set_borders_color(&mut self, clrs: Borders<ANSIBuf>)

Sets colors of border carcass on the grid.

pub fn set_border_color(&mut self, pos: Position, border: Border<ANSIBuf>)

Sets a color of border of a cell on the grid.

pub fn remove_border(&mut self, pos: Position, shape: (usize, usize))

Sets off all borders possible on the Entity.

It doesn’t changes globally set borders through SpannedConfig::set_borders.

pub fn remove_border_color(&mut self, pos: Position, shape: (usize, usize))

Gets a color of border of a cell on the grid.

pub fn get_justification(&self, entity: Entity) -> char

Get a justification which will be used while expanding cells width/height.

pub fn get_justification_color(&self, entity: Entity) -> Option<&ANSIBuf>

Get a justification color which will be used while expanding cells width/height.

None means no color.

pub fn set_justification(&mut self, entity: Entity, c: char)

Set a justification which will be used while expanding cells width/height.

pub fn set_justification_color( &mut self, entity: Entity, color: Option<ANSIBuf>, )

Set a justification color which will be used while expanding cells width/height.

None removes it.

pub fn get_column_spans(&self) -> HashMap<Position, usize>

Get a span value of the cell, if any is set.

pub fn get_row_spans(&self) -> HashMap<Position, usize>

Get a span value of the cell, if any is set.

pub fn get_column_span(&self, pos: Position) -> Option<usize>

Get a span value of the cell, if any is set.

pub fn get_row_span(&self, pos: Position) -> Option<usize>

Get a span value of the cell, if any is set.

pub fn remove_column_spans(&mut self)

Removes column spans.

pub fn remove_row_spans(&mut self)

Removes row spans.

pub fn set_column_span(&mut self, pos: Position, span: usize)

Set a column span to a given cells.

BEWARE

IT’S CALLER RESPONSIBILITY TO MAKE SURE THAT THERE NO INTERSECTIONS IN PLACE AND THE SPAN VALUE IS CORRECT

pub fn has_column_spans(&self) -> bool

Verifies if there’s any spans set.

pub fn set_row_span(&mut self, pos: Position, span: usize)

Set a column span to a given cells.

BEWARE

IT’S CALLER RESPONSIBILITY TO MAKE SURE THAT THERE NO INTERSECTIONS IN PLACE AND THE SPAN VALUE IS CORRECT

pub fn has_row_spans(&self) -> bool

Verifies if there’s any spans set.

pub fn has_border_colors(&self) -> bool

Verifies if there’s any colors set for a borders.

pub fn has_offset_chars(&self) -> bool

Verifies if there’s any colors set for a borders.

pub fn has_justification(&self) -> bool

Verifies if there’s any colors set for a borders.

pub fn has_padding(&self) -> bool

Verifies if there’s any custom padding set.

pub fn has_padding_color(&self) -> bool

Verifies if there’s any custom padding set.

pub fn has_formatting(&self) -> bool

Verifies if there’s any custom formatting set.

pub fn has_alignment_vertical(&self) -> bool

Verifies if there’s any custom alignment vertical set.

pub fn has_alignment_horizontal(&self) -> bool

Verifies if there’s any custom alignment horizontal set.

pub fn get_intersection( &self, pos: Position, shape: (usize, usize), ) -> Option<char>

Gets an intersection character which would be rendered on the grid.

grid: crate::Grid

pub fn get_horizontal(&self, pos: Position, count_rows: usize) -> Option<char>

Gets a horizontal character which would be rendered on the grid.

grid: crate::Grid

pub fn get_vertical(&self, pos: Position, count_columns: usize) -> Option<char>

Gets a vertical character which would be rendered on the grid.

grid: crate::Grid

pub fn get_horizontal_color( &self, pos: Position, count_rows: usize, ) -> Option<&ANSIBuf>

Gets a color of a cell horizontal.

pub fn get_vertical_color( &self, pos: Position, count_columns: usize, ) -> Option<&ANSIBuf>

Gets a color of a cell vertical.

pub fn get_intersection_color( &self, pos: Position, shape: (usize, usize), ) -> Option<&ANSIBuf>

Gets a color of a cell vertical.

pub fn has_horizontal(&self, row: usize, count_rows: usize) -> bool

Checks if grid would have a horizontal border with the current configuration.

grid: crate::Grid

pub fn has_vertical(&self, col: usize, count_columns: usize) -> bool

Checks if grid would have a vertical border with the current configuration.

grid: crate::Grid

pub fn count_horizontal(&self, count_rows: usize) -> usize

Calculates an amount of horizontal lines would present on the grid.

grid: crate::Grid

pub fn count_vertical(&self, count_columns: usize) -> usize

Calculates an amount of vertical lines would present on the grid.

grid: crate::Grid

pub fn is_cell_visible(&self, pos: Position) -> bool

The function returns whether the cells will be rendered or it will be hidden because of a span.

pub fn is_cell_covered_by_row_span(&self, pos: Position) -> bool

The function checks if a cell is hidden because of a row span.

pub fn is_cell_covered_by_column_span(&self, pos: Position) -> bool

The function checks if a cell is hidden because of a column span.

pub fn is_cell_covered_by_both_spans(&self, pos: Position) -> bool

The function checks if a cell is hidden indirectly because of a row and column span combination.

Trait Implementations

impl Clone for SpannedConfig

fn clone(&self) -> SpannedConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SpannedConfig

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

Formats the value using the given formatter.

impl Default for SpannedConfig

fn default() -> Self

Returns the “default value” for a type.

impl<T> Estimate<&VecRecords<T>, SpannedConfig> for SpannedVecRecordsDimension

where T: Cell + AsRef<str>,

fn estimate(&mut self, records: &VecRecords<T>, cfg: &SpannedConfig)

Estimates a metric.

impl<R> Estimate<R, SpannedConfig> for SpannedGridDimension

where R: Records, <R::Iter as IntoRecords>::Cell: AsRef<str>,

fn estimate(&mut self, records: R, cfg: &SpannedConfig)

Estimates a metric.

impl From<CompactConfig> for SpannedConfig

fn from(compact: CompactConfig) -> Self

Converts to this type from the input type.

impl PartialEq for SpannedConfig

fn eq(&self, other: &SpannedConfig) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for SpannedConfig

impl StructuralPartialEq for SpannedConfig