Title

Struct Title 

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

A builder for positioning block titles with horizontal alignment and vertical placement.

This struct handles only the positioning of titles (alignment and position), preserving any text styling you’ve already applied. You can style your text separately using TitleStyle or ratatui’s styling features.

§Examples

use tui_piechart::title::{Title, TitleStyle};
use tui_piechart::border_style::BorderStyle;

// Simple title with defaults (center top)
let simple = Title::new("Statistics");

// Style text first, then position it
let styled_text = TitleStyle::Bold.apply("Results");
let title = Title::new(styled_text)
    .right()
    .bottom();

// Position plain text
let positioned = Title::new("Dashboard")
    .center()
    .top();

§Method Chaining

All builder methods return Self, allowing for fluent method chaining:

use tui_piechart::title::Title;

let title = Title::new("My Chart")
    .center()            // horizontal alignment
    .bottom();           // vertical position

Implementations§

Source§

impl Title

Source

pub fn new(text: impl Into<String>) -> Self

Creates a new title with the given text and default positioning.

Defaults: Center alignment, Top position

The text is preserved as-is, including any styling you’ve already applied.

Source

pub fn left(self) -> Self

Sets horizontal alignment to Start (left in LTR).

Source

pub fn center(self) -> Self

Sets horizontal alignment to Center.

Source

pub fn right(self) -> Self

Sets horizontal alignment to End (right in LTR).

Source

pub fn top(self) -> Self

Sets vertical position to Top.

Source

pub fn bottom(self) -> Self

Sets vertical position to Bottom.

Source

pub fn render(&self) -> Line<'static>

Returns the text as a Line for rendering (preserves original styling).

Source

pub fn alignment(&self) -> TitleAlignment

Gets the horizontal alignment.

Source

pub fn position(&self) -> TitlePosition

Gets the vertical position.

Trait Implementations§

Source§

impl Clone for Title

Source§

fn clone(&self) -> Title

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 Debug for Title

Source§

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

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

impl<T: Into<String>> From<T> for Title

Source§

fn from(text: T) -> Self

Converts to this type from the input type.
Source§

impl From<Title> for Line<'static>

Source§

fn from(title: Title) -> Self

Converts to this type from the input type.
Source§

impl PartialEq for Title

Source§

fn eq(&self, other: &Title) -> 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 Eq for Title

Source§

impl StructuralPartialEq for Title

Auto Trait Implementations§

§

impl Freeze for Title

§

impl RefUnwindSafe for Title

§

impl Send for Title

§

impl Sync for Title

§

impl Unpin for Title

§

impl UnwindSafe for Title

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<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
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.