Struct Wrap

pub struct Wrap {
    pub trim: bool,
}

Describes how to wrap text across lines.

Examples

use ratatui::{
    text::Text,
    widgets::{Paragraph, Wrap},
};

let bullet_points = Text::from(
    r#"Some indented points:
    - First thing goes here and is long so that it wraps
    - Here is another point that is long enough to wrap"#,
);

// With leading spaces trimmed (window width of 30 chars):
Paragraph::new(bullet_points.clone()).wrap(Wrap { trim: true });
// Some indented points:
// - First thing goes here and is
// long so that it wraps
// - Here is another point that
// is long enough to wrap

// But without trimming, indentation is preserved:
Paragraph::new(bullet_points).wrap(Wrap { trim: false });
// Some indented points:
//     - First thing goes here
// and is long so that it wraps
//     - Here is another point
// that is long enough to wrap

Fields

trim: bool

Should leading whitespace be trimmed

Trait Implementations

impl Clone for Wrap

fn clone(&self) -> Wrap

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Wrap

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

Formats the value using the given formatter.

impl Default for Wrap

fn default() -> Wrap

Returns the “default value” for a type.

impl Hash for Wrap

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Wrap

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

impl Eq for Wrap

impl StructuralPartialEq for Wrap