Skip to main content

Block

Struct Block 

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

Base widget to be used with all upper level ones. It may be used to display a box border around the widget and/or add a title.

§Examples

Block::default()
    .title("Block")
    .borders(Borders::LEFT | Borders::RIGHT)
    .border_style(Style::default().fg(Color::White))
    .border_type(BorderType::Rounded)
    .style(Style::default().bg(Color::Black));

Implementations§

Source§

impl<'a> Block<'a>

Source

pub fn styled_borders( borders: Borders, border_style: impl Into<Style>, ) -> Block<'a>

Source

pub fn bordered(borders: Borders) -> Block<'a>

Source

pub fn styled(style: Style) -> Block<'a>

Source

pub fn title<T>(self, title: T) -> Block<'a>
where T: Into<Spans<'a>>,

Source

pub fn title_alignment(self, alignment: Alignment) -> Block<'a>

Source

pub fn border_style(self, style: Style) -> Block<'a>

Source

pub fn style(self, style: Style) -> Block<'a>

Source

pub fn borders(self, flag: Borders) -> Block<'a>

Source

pub fn border_type(self, border_type: BorderType) -> Block<'a>

Source

pub fn padding(self, padding: u16) -> Block<'a>

Set uniform padding on all sides

Source

pub fn padding_all( self, left: u16, right: u16, top: u16, bottom: u16, ) -> Block<'a>

Set specific padding values

Source

pub fn padding_horizontal(self, padding: u16) -> Block<'a>

Set horizontal padding

Source

pub fn padding_vertical(self, padding: u16) -> Block<'a>

Set vertical padding

Source

pub fn padding_left(self, padding: u16) -> Block<'a>

Set left padding only

Source

pub fn padding_right(self, padding: u16) -> Block<'a>

Set right padding only

Source

pub fn padding_top(self, padding: u16) -> Block<'a>

Set top padding only

Source

pub fn padding_bottom(self, padding: u16) -> Block<'a>

Set bottom padding only

Source

pub fn inner(&self, area: Rect) -> Rect

Compute the inner area of a block based on its border visibility rules and padding settings.

Trait Implementations§

Source§

impl<'a> Clone for Block<'a>

Source§

fn clone(&self) -> Block<'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 Block<'a>

Source§

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

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

impl<'a> Default for Block<'a>

Source§

fn default() -> Block<'a>

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

impl<'a> PartialEq for Block<'a>

Source§

fn eq(&self, other: &Block<'a>) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · 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<'a> Widget for Block<'a>

Source§

fn render(&mut self, area: Rect, buf: &mut Buffer)

Draws the current state of the widget in the given buffer. That is the only method required to implement a custom widget.
Source§

impl<'a> Eq for Block<'a>

Source§

impl<'a> StructuralPartialEq for Block<'a>

Auto Trait Implementations§

§

impl<'a> Freeze for Block<'a>

§

impl<'a> RefUnwindSafe for Block<'a>

§

impl<'a> Send for Block<'a>

§

impl<'a> Sync for Block<'a>

§

impl<'a> Unpin for Block<'a>

§

impl<'a> UnsafeUnpin for Block<'a>

§

impl<'a> UnwindSafe for Block<'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> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more