Skip to main content

ComponentContext

Struct ComponentContext 

Source
#[non_exhaustive]
pub struct ComponentContext<'a> { pub console: &'a Console, pub width: usize, pub height: usize, }
Expand description

What a component renders and handles events for: the console to render with, and the space it has.

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§console: &'a Console§width: usize

Columns available.

§height: usize

Rows available; a taller view is cut off at the bottom.

Implementations§

Source§

impl<'a> ComponentContext<'a>

Source

pub fn new( console: &'a Console, width: usize, height: usize, ) -> ComponentContext<'a>

Source

pub fn lines(&self, renderable: &dyn Renderable) -> Vec<Vec<Segment>>

Render renderable at the context’s width into lines.

Source

pub fn markup(&self, markup: &str) -> Vec<Vec<Segment>>

Render console markup into lines. Markup that does not parse is shown as it is.

Auto Trait Implementations§

§

impl<'a> !RefUnwindSafe for ComponentContext<'a>

§

impl<'a> !UnwindSafe for ComponentContext<'a>

§

impl<'a> Freeze for ComponentContext<'a>

§

impl<'a> Send for ComponentContext<'a>

§

impl<'a> Sync for ComponentContext<'a>

§

impl<'a> Unpin for ComponentContext<'a>

§

impl<'a> UnsafeUnpin for ComponentContext<'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> 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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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.