Struct ParagraphBox 

pub struct ParagraphBox {
    pub width: f32,
    pub glue_before: f32,
    pub stretch_before: f32,
    pub shrink_before: f32,
    pub break_before: bool,
    pub break_penalty: i32,
    pub flagged_break: bool,
    pub break_width: f32,
    pub end_protrusion: f32,
}

One shaped box in logical order. A box is usually a word or an unbreakable inline fragment; callers retain the actual glyph/style data separately.

Fields

width: f32

Natural shaped advance of this fragment.

glue_before: f32

Natural glue before this fragment. It is ignored when the fragment is first on a line.

stretch_before: f32

Additional stretch capacity at this boundary. Zero derives capacity from natural glue; a positive value supports script-specific expansion such as spacing between CJK ideographs.

shrink_before: f32

Additional shrink capacity at this boundary. Zero derives capacity from natural glue.

break_before: bool

Whether a line may end immediately before this fragment.

break_penalty: i32

Extra demerit for breaking before this fragment. Positive values make the break less desirable; a negative value encourages it.

flagged_break: bool

Whether this is a flagged break such as a discretionary hyphen.

break_width: f32

Width added only when the line ends at this boundary (for example the visible hyphen exercised by a discretionary break).

end_protrusion: f32

Portion of this box allowed to protrude beyond the right margin when it ends a line. Typically a fraction of a closing punctuation glyph.

Implementations

impl ParagraphBox

pub const fn word(width: f32, glue_before: f32) -> ParagraphBox

Trait Implementations

impl Clone for ParagraphBox

fn clone(&self) -> ParagraphBox

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ParagraphBox

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

Formats the value using the given formatter.

impl PartialEq for ParagraphBox

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for ParagraphBox

impl StructuralPartialEq for ParagraphBox