Struct LineBreakConfig 

#[non_exhaustive]
pub struct LineBreakConfig {
    pub wrap: TextWrap,
    pub break_at_hyphens: bool,
}

Configuration for line breaking behavior.

Provides control over how text wraps and breaks across lines. Currently uses cosmic-text’s built-in line breaking. Future versions will support UAX#14 customization.

Example

use astrelis_text::{LineBreakConfig, TextWrap};

let config = LineBreakConfig::new(TextWrap::WordOrGlyph)
    .with_hyphen_breaks(true);

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

wrap: TextWrap

The wrapping mode to use.

break_at_hyphens: bool

Whether to allow breaks at hyphens (e.g., “self-aware” can break at “-”). Default: true

Implementations

impl LineBreakConfig

pub fn new(wrap: TextWrap) -> Self

Create a new line break configuration with the specified wrap mode.

Arguments

• wrap - The text wrapping mode to use

Example

use astrelis_text::{LineBreakConfig, TextWrap};

let config = LineBreakConfig::new(TextWrap::Word);

pub fn with_hyphen_breaks(self, allow: bool) -> Self

Configure whether to allow breaks at hyphens.

When enabled, hyphenated words like “self-aware” can break at the hyphen. Default is true.

Arguments

• allow - Whether to allow breaks at hyphens

Example

use astrelis_text::{LineBreakConfig, TextWrap};

// Disable hyphen breaks for technical terms
let config = LineBreakConfig::new(TextWrap::Word)
    .with_hyphen_breaks(false);

pub fn wrap(&self) -> TextWrap

Get the wrap mode.

pub fn breaks_at_hyphens(&self) -> bool

Check if hyphen breaks are enabled.

Trait Implementations

impl Clone for LineBreakConfig

fn clone(&self) -> LineBreakConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LineBreakConfig

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

Formats the value using the given formatter.

impl Default for LineBreakConfig

fn default() -> LineBreakConfig

Returns the “default value” for a type.