Struct StyledTextLayoutParams

Source
pub struct StyledTextLayoutParams<'a> {
    pub text: &'a str,
    pub base_style: TextStyle,
    pub spans: &'a [StyledTextSpan],
    pub max_width: Option<f32>,
    pub wrap_mode: WrapMode,
}
Expand description

Inputs for styled text layout. Spans affect cache invalidation and prepare the pipeline for syntax-colored runs while preserving a single layout pass.

Overlapping spans are forwarded in slice order to Parley. Every span range must be a valid UTF-8 range in text; callers should not rely on this data structure to clip or repair invalid ranges.

§Examples

use ailloli_ui_core::{Color, FontId, TextStyle};
use ailloli_ui_text::{StyledTextLayoutParams, StyledTextSpan, WrapMode};

let base = TextStyle::new(FontId::Mono, 14, Color::WHITE);
let spans = [StyledTextSpan { range: 0..2, style: base.underline() }];
let params = StyledTextLayoutParams {
    text: "fn main",
    base_style: base,
    spans: &spans,
    max_width: Some(120.0),
    wrap_mode: WrapMode::Word,
};
assert_eq!(params.spans.len(), 1);

Fields§

§text: &'a str

UTF-8 text to shape; an empty string is valid.

§base_style: TextStyle

Style used outside overridden ranges.

§spans: &'a [StyledTextSpan]

Ordered range overrides, borrowed for the duration of the request.

§max_width: Option<f32>

Optional wrap width in logical pixels; None means unconstrained.

§wrap_mode: WrapMode

Line-breaking policy.

Trait Implementations§

Source§

impl<'a> Clone for StyledTextLayoutParams<'a>

Source§

fn clone(&self) -> StyledTextLayoutParams<'a>

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<'a> Debug for StyledTextLayoutParams<'a>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'a> Copy for StyledTextLayoutParams<'a>

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.
§

impl<T> ErasedDestructor for T
where T: 'static,