Skip to main content

LineWrapper

Struct LineWrapper 

Source
pub struct LineWrapper { /* private fields */ }
Expand description

The GPUI line wrapper, used to wrap lines of text to a given width.

Implementations§

Source§

impl LineWrapper

Source

pub const MAX_INDENT: u32 = 256

The maximum indent that can be applied to a line.

Source

pub fn new( font_id: FontId, font_size: Pixels, text_system: Arc<dyn TextSystem>, ) -> Self

Creates a wrapper that measures and truncates text through text_system.

Source

pub fn wrap_line<'a>( &'a mut self, fragments: &'a [LineFragment<'_>], wrap_width: Pixels, ) -> impl Iterator<Item = Boundary> + 'a

Wrap a line of text to the given width with this wrapper’s font and font size.

Source

pub fn should_truncate_line( &mut self, line: &str, truncate_width: Pixels, truncation_affix: &str, truncate_from: TruncateFrom, ) -> Option<usize>

Determines if a line should be truncated based on its width.

Returns the truncation index in line.

Source

pub fn truncate_line<'a>( &mut self, line: SharedString, truncate_width: Pixels, truncation_affix: &str, runs: &'a [TextRun], truncate_from: TruncateFrom, ) -> (SharedString, Cow<'a, [TextRun]>)

Truncate a line of text to the given width with this wrapper’s font and font size.

Source

pub fn truncate_wrapped_line<'a>( &mut self, text: SharedString, wrap_width: Pixels, max_lines: usize, truncation_affix: &str, runs: &'a [TextRun], truncate_from: TruncateFrom, ) -> (SharedString, Cow<'a, [TextRun]>)

Truncate text to fit within a given number of wrapped lines.

Unlike truncate_line which treats the text as a flat width budget (width * max_lines), this method accounts for word-boundary wrapping: it walks through characters once, tracking wrap boundaries and the truncation point simultaneously. When text overflows on the last allowed line, it truncates there and appends the affix.

For max_lines == 1, this delegates to truncate_line.

Source

pub fn is_word_char(c: char) -> bool

Any character in this list should be treated as a word character, meaning it can be part of a word that should not be wrapped. Returns whether c may be part of a word that should not be wrapped.

Source

pub fn width_for_char(&mut self, c: char) -> Pixels

The advance width of c in this wrapper’s font, cached after first use.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.