Struct boxworks::ds::Rule

pub struct Rule {
    pub height: Scaled,
    pub width: Scaled,
    pub depth: Scaled,
}

A rule stands for a solid black rectangle.

It has width, depth and height fields. However if any of these dimensions is -2^30, the actual value will be determined by running rule up to the boundary of the innermost, enclosing box. This is called a “running dimension”. The width is never running in an hlist; the height and depth are never running in a vlist.

Described in TeX.2021.138.

Fields

height: Scaled

width: Scaled

depth: Scaled

Implementations

impl Rule

pub const RUNNING: Number = _

pub fn new() -> Self

Creates a new rule.

All of the dimensions are running.

Described in TeX.2021.139.

Trait Implementations

impl Debug for Rule

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

Formats the value using the given formatter.

impl Default for Rule

fn default() -> Self

Returns the “default value” for a type.

impl From<Rule> for Horizontal

fn from(value: Rule) -> Self

Converts to this type from the input type.

impl PartialEq for Rule

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

impl StructuralPartialEq for Rule