Enum roff::Inline

pub enum Inline {
    Roman(String),
    Italic(String),
    Bold(String),
    LineBreak,
}

A part of a text line.

Text will be escaped for ROFF. No inline escape sequences will be passed to ROFF. The text may contain newlines, but leading periods will be escaped so that they won’t be interpreted by ROFF as control lines.

Note that the strings stored in the variants are stored as they’re received from the API user. The Line::render function handles escaping etc.

Variants

Roman(String)

Tuple Fields

0: String

Text in the “roman” font, which is the normal font if nothing else is specified.

Italic(String)

Tuple Fields

0: String

Text in the italic (slanted) font.

Bold(String)

Tuple Fields

0: String

Text in a bold face font.

LineBreak

A hard line break. This is an inline element so it’s easy to insert a line break in a paragraph.

Trait Implementations

impl Clone for Inline

fn clone(&self) -> Inline

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Inline

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

Formats the value using the given formatter.

impl<S: Into<String>> From<S> for Inline

Turn a string slice into inline text in the roman font.

This is equivalent to the roman function, but may be more convenient to use.

fn from(s: S) -> Self

Performs the conversion.

impl PartialEq<Inline> for Inline

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Eq for Inline

impl StructuralEq for Inline

impl StructuralPartialEq for Inline