Skip to main content

Context

Struct Context 

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

What a widget is told when it measures and renders: the width to fill, the tab stop spacing, and the box characters.

A context holds no colour or terminal fact. Styles are resolved before layout, and escape sequences are written after it.

It is Clone but not Copy, so a later release can add a field without breaking a caller that copies it. A widget takes &Context.

The at_* and using_* methods return a changed clone, so a container derives the context of a child from its own: context.at_width(column).

Implementations§

Source§

impl Context

Source

pub fn new(width: u16) -> Self

A context width cells wide, with tab stops every TAB_WIDTH cells and Unicode box characters.

Source

pub fn unbounded() -> Self

A context with no width limit, so a widget takes its natural width.

width reports u16::MAX, so layout arithmetic needs no special case, and is_unbounded tells a caller that the width is no limit and not a real one. Every method that returns a changed clone keeps the flag, including at_width.

Source

pub fn at_width(&self, width: u16) -> Self

This context at another width.

Source

pub fn at_tab_width(&self, tab_width: NonZeroU16) -> Self

This context with tab stops every tab_width cells.

Source

pub fn using_box_chars(&self, box_chars: BoxChars) -> Self

This context with box_chars for borders.

Source

pub fn width(&self) -> u16

The width in cells that rendered lines should fit.

Source

pub fn is_unbounded(&self) -> bool

Whether this context was made by unbounded, so width is no limit.

Source

pub fn tab_width(&self) -> NonZeroU16

The spacing of tab stops, in cells.

Source

pub fn box_chars(&self) -> BoxChars

The characters to draw borders and rules with.

Trait Implementations§

Source§

impl Clone for Context

Source§

fn clone(&self) -> Self

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

Source§

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

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

impl Eq for Context

Source§

impl Hash for Context

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for Context

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Context

Auto Trait Implementations§

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 = !

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.