Struct Definitions 

pub struct Definitions { /* private fields */ }

Entries, each a line of labels over indented lines of description.

An entry with two labels and one description line draws as:

  -f --format
    Output representation

It is the form of a table of flags or commands for a narrow width, where the columns no longer fit side by side. Put it in a Breakpoint beside the table.

The labels of an entry share one line, separated by a space. Its description lines go below, wrapped at spaces to the width that is left. An entry whose labels or description are empty skips that part.

Implementations

impl Definitions

pub fn new() -> Self

A list with no entries.

pub fn entry<L, D>( self, labels: impl IntoIterator<Item = L>, description: impl IntoIterator<Item = D>, ) -> Self

where L: Into<Text>, D: Into<Text>,

Adds an entry: its labels on a line indented by 2, and its description below them, indented by 4. Each label and description line converts to a Text, and one with no text adds nothing.

Trait Implementations

impl Clone for Definitions

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Definitions

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

Formats the value using the given formatter.

impl Default for Definitions

fn default() -> Self

Returns the “default value” for a type.

impl Renderable for Definitions

fn measure(&self, context: &Context) -> Measurement

The narrowest and widest this content can usefully be.

fn render(&self, context: &Context) -> Vec<Line>

Lines no wider than context.width(), except a word or cluster that the content’s overflow policy keeps whole.