Skip to main content

GridStyle

Struct GridStyle 

Source
pub struct GridStyle { /* private fields */ }
Expand description

A grid’s geometry: an optional Length per column and the padding its cells take.

A GridStyle is an immutable value, like BlockStyle. It holds no box geometry or line presentation: a grid that needs a border, margin, or stated size is placed inside a View::Block, while a presentation that needs an internal line network owns it in a Canvas.

use urushi::{GridStyle, Length, TextStyle, View, measure};

let style = GridStyle::new()
    .cell_padding((0, 1))
    .columns([None, Some(Length::fill(1))]);
let grid = View::grid(
    style,
    [
        [View::text("id", TextStyle::new()), View::text("name", TextStyle::new())],
        [View::text("1", TextStyle::new()), View::text("urushi", TextStyle::new())],
    ],
);

assert_eq!(measure(&grid).height(), 2);

Implementations§

Source§

impl GridStyle

Source

pub fn new() -> Self

Source

pub fn columns(self, columns: impl IntoIterator<Item = Option<Length>>) -> Self

States the Length each column claims, left to right.

A column with no stated length — an absent entry, or one past the end of this list — is auto: it claims the intrinsic width of the cells beneath it. A stated length supplies only the kind of the claim; the demand and the floor still come from those cells.

Source

pub fn reset_columns(self) -> Self

Restores all column length claims to their default value.

Source

pub fn cell_padding(self, sides: impl Into<Sides>) -> Self

Sets the padding every cell that states none of its own takes.

A cell that states its own padding replaces this value rather than adding to it. Columns stay aligned either way: a column is as wide as its widest cell, whatever padding that cell carries.

Source

pub fn reset_cell_padding(self) -> Self

Restores the default cell padding.

Source

pub fn get_column(&self, index: usize) -> Option<Length>

Returns the stated length of column index, if it states one.

Source

pub const fn get_cell_padding(&self) -> Sides

Returns the padding a cell that states none of its own takes.

Trait Implementations§

Source§

impl Clone for GridStyle

Source§

fn clone(&self) -> GridStyle

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for GridStyle

Source§

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

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

impl Default for GridStyle

Source§

fn default() -> GridStyle

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

impl PartialEq for GridStyle

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Eq for GridStyle

Source§

impl StructuralPartialEq for GridStyle

Auto Trait Implementations§

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.