Skip to main content

PrintLine

Struct PrintLine 

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

A Line, drawn on the first row of the area it’s rendered into and clipped to area.width() columns. Only the first row is used.

align defaults to Align::Left (drawn at the left edge); set it with PrintLine::align to right-align or center the whole line’s spans as a unit within area.width() columns.

§Examples

use retroglyph_core::backend::Headless;
use retroglyph_core::text::Line;
use retroglyph_core::{Rect, Terminal};
use retroglyph_widgets::{PrintLine, Widget};

let mut term = Terminal::new(Headless::new(20, 1));
let line = Line::raw("hello");
term.draw(|surface| {
    PrintLine::new(&line).render(Rect::new(0, 0, 20, 1), surface);
})
.unwrap();

Implementations§

Source§

impl<'a> PrintLine<'a>

Source

pub const fn new(line: &'a Line) -> Self

Print line, left-aligned and clipped to whatever width it’s rendered at.

Source

pub const fn align(self, align: Align) -> Self

Set how the line’s spans are aligned, as a unit, within area.width() columns.

Trait Implementations§

Source§

impl<'a> Clone for PrintLine<'a>

Source§

fn clone(&self) -> PrintLine<'a>

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<'a> Copy for PrintLine<'a>

Source§

impl<'a> Debug for PrintLine<'a>

Source§

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

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

impl Widget for PrintLine<'_>

Source§

fn render(&self, area: Rect, surface: &mut Surface<'_>)

Draw this widget into area, via surface scoped to it.

Auto Trait Implementations§

§

impl<'a> Freeze for PrintLine<'a>

§

impl<'a> RefUnwindSafe for PrintLine<'a>

§

impl<'a> Send for PrintLine<'a>

§

impl<'a> Sync for PrintLine<'a>

§

impl<'a> Unpin for PrintLine<'a>

§

impl<'a> UnsafeUnpin for PrintLine<'a>

§

impl<'a> UnwindSafe for PrintLine<'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, 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<C> WithAlpha for C
where C: Copy,

Source§

fn with_alpha_first<A>(self, alpha: A) -> AlphaFirst<A, Self>

Wraps self with alpha, storing alpha before the color in memory (see AlphaFirst).
Source§

fn with_alpha_last<A>(self, alpha: A) -> AlphaLast<A, Self>

Wraps self with alpha, storing alpha after the color in memory (see AlphaLast).