Struct boxworks::ds::Discretionary

pub struct Discretionary {
    pub pre_break: Vec<Horizontal>,
    pub post_break: Vec<Horizontal>,
    pub replace_count: u32,
}

A discretionary break.

The pre-break and post-break lists must only contain nodes of type char, kern, box, rule or ligature. We could have a specific node type for this, but for the moment we just piggy back on the hlist type.

Described in TeX.2021.145.

Fields

pre_break: Vec<Horizontal>

Material to insert before this node, if the break occurs here.

post_break: Vec<Horizontal>

Material to insert after this node, if the break occurs here.

replace_count: u32

Number of subsequent nodes to skip if the break occurs here.

Implementations

impl Discretionary

pub fn new() -> Self

Trait Implementations

impl Debug for Discretionary

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

Formats the value using the given formatter.

impl Default for Discretionary

fn default() -> Self

Returns the “default value” for a type.

impl From<Discretionary> for Horizontal

fn from(value: Discretionary) -> Self

Converts to this type from the input type.

impl PartialEq for Discretionary

fn eq(&self, other: &Discretionary) -> 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 Eq for Discretionary

impl StructuralPartialEq for Discretionary