Skip to main content

AttrsList

Struct AttrsList 

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

A list of text attributes with default styling and per-range overrides.

AttrsList pairs a set of default Attrs with zero or more byte-range spans that override specific properties. When applied to a Parley builder via apply_to_builder, the defaults are pushed first, then each span is layered on top for its range.

§Example

use floem_renderer::text::{Attrs, AttrsList, FontWeight};
use peniko::Color;

let mut attrs_list = AttrsList::new(Attrs::new().font_size(14.0));

// Make bytes 0..5 bold and red.
attrs_list.add_span(
    0..5,
    Attrs::new()
        .font_size(14.0)
        .weight(FontWeight::BOLD)
        .color(Color::WHITE),
);

Implementations§

Source§

impl AttrsList

Source

pub fn new(defaults: Attrs<'_>) -> Self

Creates a new attribute list with the given default attributes and no spans.

Source

pub fn defaults(&self) -> Attrs<'_>

Returns the default attributes.

Source

pub fn clear_spans(&mut self)

Removes all attribute spans, keeping only the defaults.

Source

pub fn add_span(&mut self, range: Range<usize>, attrs: Attrs<'_>)

Adds an attribute span for the given byte range.

Any existing spans that overlap with range are removed before the new span is inserted.

Source

pub fn get_span(&self, index: usize) -> Attrs<'_>

Returns the attributes at the given byte index.

If a span covers index, its attributes are returned. Otherwise the defaults are returned.

Source

pub fn split_off(&mut self, index: usize) -> Self

Splits this attribute list at the given byte index.

Returns a new AttrsList covering [index..) with span ranges shifted to start from zero. Spans that cross the split point are duplicated into both halves with their ranges adjusted accordingly. self is left containing only the [..index) portion.

Source

pub fn apply_to_builder(&self, builder: &mut RangedBuilder<'_, TextBrush>)

Applies all defaults and spans to a Parley RangedBuilder.

This first pushes the default attributes, then layers each span on top for its byte range. Span properties that match the defaults are skipped to avoid redundant work.

Source

pub fn spans(&self) -> &[(Range<usize>, AttrsOwned)]

Returns the inner spans as a slice of (byte_range, attributes) pairs.

Trait Implementations§

Source§

impl Clone for AttrsList

Source§

fn clone(&self) -> AttrsList

Returns a duplicate 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 Debug for AttrsList

Source§

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

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

impl PartialEq for AttrsList

Source§

fn eq(&self, _other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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
§

impl<T> Downcast<T> for T

§

fn downcast(&self) -> &T

§

impl<T> Downcast for T
where T: Any,

§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> 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> Upcast<T> for T

§

fn upcast(&self) -> Option<&T>

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

impl<T> WasmNotSend for T
where T: Send,

§

impl<T> WasmNotSendSync for T
where T: WasmNotSend + WasmNotSync,

§

impl<T> WasmNotSync for T
where T: Sync,