Struct WrapOpts 

pub struct WrapOpts {
    pub preserve_spaces: bool,
    pub hard_break_long_tokens: bool,
    pub trim_end: bool,
    pub continuation_prefix: Option<Vec<Span>>,
}

Options controlling span-aware word wrapping.

These settings are intentionally generic and suitable for help viewers, log viewers, search UIs, and other terminal applications.

Fields

preserve_spaces: bool

Preserve whitespace runs exactly as provided.

When false, whitespace runs are normalized to a single ASCII space, and leading whitespace at the beginning of a visual line is dropped.

hard_break_long_tokens: bool

If a single non-whitespace token exceeds the available width, hard-break it by grapheme cluster.

trim_end: bool

Trim trailing whitespace at the end of each visual line.

continuation_prefix: Option<Vec<Span>>

Optional prefix to apply to continuation lines produced by wrapping.

A continuation line is a visual line created because a token would exceed the available width and the line is wrapped. Explicit newline characters do not produce continuation lines.

The prefix is only applied if its measured cell width is strictly less than width.

Trait Implementations

impl Clone for WrapOpts

fn clone(&self) -> WrapOpts

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WrapOpts

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

Formats the value using the given formatter.

impl Default for WrapOpts

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for WrapOpts

where WrapOpts: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for WrapOpts

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for WrapOpts

impl StructuralPartialEq for WrapOpts