Struct Layout 

pub struct Layout<B: Brush> { /* private fields */ }

Text layout.

Implementations

impl<B: Brush> Layout<B>

pub fn new() -> Self

Creates an empty layout.

pub fn scale(&self) -> f32

Returns the scale factor provided when creating the layout.

pub fn styles(&self) -> &[Style<B>]

Returns the style collection for the layout.

pub fn width(&self) -> f32

Returns the width of the layout.

pub fn full_width(&self) -> f32

Returns the width of the layout, including the width of any trailing whitespace.

pub fn calculate_content_widths(&self) -> ContentWidths

Calculates the lower and upper bounds on the width of the layout. These are recalculated every time this method is called.

This method currently may not return the correct results for mixed-direction text.

pub fn height(&self) -> f32

Returns the height of the layout.

pub fn len(&self) -> usize

Returns the number of lines in the layout.

pub fn is_empty(&self) -> bool

Returns true if the layout is empty.

pub fn get(&self, index: usize) -> Option<Line<'_, B>>

Returns the line at the specified index.

Returns None if the index is out of bounds, i.e. if it’s not less than self.len().

pub fn is_rtl(&self) -> bool

Returns true if the dominant direction of the layout is right-to-left.

pub fn inline_boxes(&self) -> &[InlineBox]

pub fn inline_boxes_mut(&mut self) -> &mut [InlineBox]

pub fn lines(&self) -> impl Iterator<Item = Line<'_, B>> + '_ + Clone

Returns an iterator over the lines in the layout.

pub fn break_lines(&mut self) -> BreakLines<'_, B>

Returns line breaker to compute lines for the layout.

pub fn break_all_lines(&mut self, max_advance: Option<f32>)

Breaks all lines with the specified maximum advance.

pub fn align( &mut self, container_width: Option<f32>, alignment: Alignment, options: AlignmentOptions, )

Apply alignment to the layout relative to the specified container width or full layout width.

You must perform line breaking prior to aligning, through Layout::break_lines or Layout::break_all_lines. If container_width is not specified, the layout’s Layout::width is used.

Trait Implementations

impl<B: Clone + Brush> Clone for Layout<B>

fn clone(&self) -> Layout<B>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<B: Brush> Default for Layout<B>

fn default() -> Self

Returns the “default value” for a type.