Struct RoundedDashedBorder 

pub struct RoundedDashedBorder(pub Borders);

A dashed border with rounded corners.

This is a wrapper around Borders with Deref and DerefMut implementations for convenient access to the underlying Borders configuration.

Examples

use ratatui_garnish::border::{Borders, RoundedDashedBorder};

let border = RoundedDashedBorder::default();
let custom = RoundedDashedBorder::new(Borders::TOP | Borders::BOTTOM);

Tuple Fields

0: Borders

Implementations

impl RoundedDashedBorder

pub const fn new(borders: Borders) -> Self

Creates a new border with the specified configuration.

Methods from Deref<Target = Borders>

pub const NONE: Self

pub const TOP: Self

pub const RIGHT: Self

pub const BOTTOM: Self

pub const LEFT: Self

pub const ALL: Self

pub fn bits(&self) -> u8

Get the underlying bits value.

The returned value is exactly the bits set in this flags value.

pub fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

pub fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

pub fn intersects(&self, other: Self) -> bool

Whether any set bits in a source flags value are also set in a target flags value.

pub fn contains(&self, other: Self) -> bool

Whether all set bits in a source flags value are also set in a target flags value.

pub fn insert(&mut self, other: Self)

The bitwise or (|) of the bits in two flags values.

pub fn remove(&mut self, other: Self)

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. remove won’t truncate other, but the ! operator will.

pub fn toggle(&mut self, other: Self)

The bitwise exclusive-or (^) of the bits in two flags values.

pub fn set(&mut self, other: Self, value: bool)

Call insert when value is true or remove when value is false.

pub fn iter(&self) -> Iter<Borders>

Yield a set of contained flags values.

Each yielded flags value will correspond to a defined named flag. Any unknown bits will be yielded together as a final flags value.

pub fn iter_names(&self) -> IterNames<Borders>

Yield a set of contained named flags values.

This method is like iter, except only yields bits in contained named flags. Any unknown bits, or bits not corresponding to a contained flag will not be yielded.

Trait Implementations

impl Border for RoundedDashedBorder

fn get_borders(&self) -> Borders

Returns the border configuration.

fn get_border_set(&self) -> BorderSet

Returns the character set used for rendering.

fn render_left(&self, area: Rect, buffer: &mut Buffer, symbol: char)

Renders the left border.

fn render_top(&self, area: Rect, buffer: &mut Buffer, symbol: char)

Renders the top border.

fn render_right(&self, area: Rect, buffer: &mut Buffer, symbol: char)

Renders the right border.

fn render_bottom(&self, area: Rect, buffer: &mut Buffer, symbol: char)

Renders the bottom border.

fn render_corners(&self, area: Rect, buffer: &mut Buffer, charset: &BorderSet)

Renders the corner characters if adjacent sides are present.

impl Clone for RoundedDashedBorder

fn clone(&self) -> RoundedDashedBorder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RoundedDashedBorder

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

Formats the value using the given formatter.

impl Default for RoundedDashedBorder

fn default() -> Self

Creates a border with all sides enabled.

impl Deref for RoundedDashedBorder

type Target = Borders

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for RoundedDashedBorder

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<'a, W> Extend<RoundedDashedBorder> for GarnishedStatefulWidget<'a, W>

fn extend<A: IntoIterator<Item = RoundedDashedBorder>>(&mut self, iter: A)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl<'a, W> Extend<RoundedDashedBorder> for GarnishedWidget<'a, W>

fn extend<A: IntoIterator<Item = RoundedDashedBorder>>(&mut self, iter: A)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl<'a> Extend<RoundedDashedBorder> for Garnishes<'a>

fn extend<A: IntoIterator<Item = RoundedDashedBorder>>(&mut self, iter: A)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl<'a> From<RoundedDashedBorder> for Garnish<'a>

fn from(value: RoundedDashedBorder) -> Self

Converts to this type from the input type.

impl Hash for RoundedDashedBorder

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for RoundedDashedBorder

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Copy for RoundedDashedBorder

impl Eq for RoundedDashedBorder

impl StructuralPartialEq for RoundedDashedBorder