Enum nannou::text::line::Break

pub enum Break {
    Wrap {
        byte: usize,
        char: usize,
        len_bytes: usize,
        len_chars: usize,
    },
    Newline {
        byte: usize,
        char: usize,
        len_bytes: usize,
        len_chars: usize,
    },
    End {
        byte: usize,
        char: usize,
    },
}

The two types of Break indices returned by the WrapIndicesBy iterators.

Variants

Wrap

A break caused by the text exceeding some maximum width.

Fields of Wrap

byte: usize

The byte index at which the break occurs.

char: usize

The char index at which the string should wrap due to exceeding a maximum width.

len_bytes: usize

The byte length which should be skipped in order to reach the first non-whitespace character to use as the beginning of the next line.

len_chars: usize

The number of chars which should be skipped in order to reach the first non-whitespace character to use as the beginning of the next line.

Newline

A break caused by a newline character.

Fields of Newline

byte: usize

The byte index at which the string should wrap due to exceeding a maximum width.

char: usize

The char index at which the string should wrap due to exceeding a maximum width.

len_bytes: usize

The width of the “newline” token in bytes.

len_chars: usize

The width of the “newline” token in chars.

End

The end of the string has been reached, with the given length.

Fields of End

byte: usize

The ending byte index.

char: usize

The ending char index.

Implementations

impl Break

pub fn byte_index(self) -> usize

Return the index at which the break occurs.

pub fn char_index(self) -> usize

Return the index of the char at which the break occurs.

To clarify, this index is to be used in relation to the Chars iterator.

Trait Implementations

impl Clone for Break

fn clone(&self) -> Break

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Break

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

Formats the value using the given formatter.

impl PartialEq<Break> for Break

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

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

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

This method tests for !=.

impl Copy for Break

impl StructuralPartialEq for Break