Enum pretty_trait::Conditional

pub enum Conditional<T> {
    Always(T),
    OnlyBroken(T),
    OnlyUnbroken(T),
}

A wrapper which decides whether or not to render its contents based on the breaking mode of the environment.

Examples

Adding a trailing comma only when broken:

use pretty_trait::{JoinExt, Sep, Conditional, to_string};

let max_line = Some(10);
let tab_size = 4;

let to_render = "lorem,"
    .join(Sep(1))
    .join("ipsum,")
    .join(Sep(1))
    .join("dolor,")
    .join(Sep(1))
    .join("sit,")
    .join(Sep(1))
    .join("amet")
    .join(Conditional::OnlyBroken(","));

// Trailing comma when broken across multiple lines:

let expected_broken = "\
lorem,
ipsum,
dolor,
sit,
amet,";

assert_eq!(to_string(&to_render, max_line, tab_size), expected_broken);

// No trailing comma when rendered on a single line:

assert_eq!(
    to_string(&to_render, None, tab_size),
    "lorem, ipsum, dolor, sit, amet"
);

Variants

Always(T)

Render the wrapped value under all circumstances

OnlyBroken(T)

Render the wrapped value only when it appears in a multi-line context

OnlyUnbroken(T)

Render the wrapped value only when it appears in a single-line context

Trait Implementations

impl<T: Clone> Clone for Conditional<T>

fn clone(&self) -> Conditional<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Copy> Copy for Conditional<T>

impl<T: Debug> Debug for Conditional<T>

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl<T: Pretty> Pretty for Conditional<T>

fn size(&self) -> Size

Calculate the intrinsic size of this value, if it were to be displayed on a single line.

fn pretty_write(&self, context: Context) -> Result<()>

Render this value in a given context.