Skip to main content

Attrs

Struct Attrs 

Source
pub struct Attrs<'a> {
    pub font_size: f32,
    /* private fields */
}
Expand description

Text styling attributes used to configure font properties, color, and layout.

Attrs uses a builder pattern where each setter consumes and returns self, making it easy to chain calls. Unset fields (None) inherit from the layout defaults when applied to a Parley builder.

§Defaults

PropertyDefault
font_size16.0
line_heightLineHeightValue::Normal(1.0)
colorNone (inherits from context)
familyNone (system default)
weightNone (normal)
styleNone (normal)
font_widthNone (normal)
metadataNone

§Example

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

let families = [FamilyOwned::Name("Inter".to_string()), FamilyOwned::SansSerif];
let attrs = Attrs::new()
    .family(&families)
    .font_size(14.0)
    .weight(FontWeight::BOLD)
    .color(Color::WHITE)
    .line_height(LineHeightValue::Normal(1.4));

Fields§

§font_size: f32

Font size in pixels.

Implementations§

Source§

impl<'a> Attrs<'a>

Source

pub fn new() -> Self

Creates a new Attrs with default values (16px font, 1.0 line height multiplier).

Source

pub fn color(self, color: Color) -> Self

Sets the text color.

Source

pub fn family(self, family: &'a [FamilyOwned]) -> Self

Sets the font family list. Families are tried in order as fallbacks.

Source

pub fn font_width(self, stretch: FontWidth) -> Self

Sets the font width (stretch), e.g. condensed or expanded.

Source

pub fn font_style(self, font_style: FontStyle) -> Self

Sets the font style (normal, italic, or oblique).

Source

pub fn weight(self, weight: FontWeight) -> Self

Sets the font weight (e.g. FontWeight::BOLD).

Source

pub fn raw_weight(self, weight: u16) -> Self

Sets the font weight from a raw numeric value (typically 100–900).

Source

pub fn font_size(self, font_size: f32) -> Self

Sets the font size in pixels.

Source

pub fn word_break(self, word_break: WordBreakStrength) -> Self

Sets the word break strength used when text wrapping is enabled.

Source

pub fn line_height(self, line_height: LineHeightValue) -> Self

Sets the line height. See LineHeightValue for the available modes.

Source

pub fn metadata(self, metadata: usize) -> Self

Sets an opaque metadata value that is carried through layout.

This can be used to associate application-specific data (e.g. a span identifier) with a range of text.

Source

pub fn get_color(&self) -> Option<Color>

Returns the text color, or None if unset.

Source

pub fn get_line_height(&self) -> LineHeightValue

Returns the line height setting.

Source

pub fn get_family(&self) -> Option<&'a [FamilyOwned]>

Returns the font family list, or None if unset.

Source

pub fn get_weight(&self) -> Option<FontWeight>

Returns the font weight, or None if unset.

Source

pub fn get_font_style(&self) -> Option<FontStyle>

Returns the font style, or None if unset.

Source

pub fn get_stretch(&self) -> Option<FontWidth>

Returns the font width (stretch), or None if unset.

Source

pub fn get_word_break(&self) -> Option<WordBreakStrength>

Returns the word break strength, or None if unset.

Source

pub fn get_metadata(&self) -> Option<usize>

Returns the metadata value, or None if unset.

Source

pub fn effective_line_height(&self) -> f32

Computes the effective line height in pixels.

For LineHeightValue::Normal, this multiplies the font size by the factor. For LineHeightValue::Pt, the point value is returned directly.

Source

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

Pushes all set properties as defaults onto a Parley RangedBuilder.

Font size and line height are always pushed. Optional properties (color, family, weight, style, width) are only pushed when set.

Source

pub fn apply_range( &self, builder: &mut RangedBuilder<'_, TextBrush>, range: Range<usize>, defaults: &Attrs<'_>, )

Pushes style properties for a specific byte range onto a Parley RangedBuilder.

Only properties that differ from defaults are pushed, avoiding redundant work when a span shares most attributes with the base style.

Trait Implementations§

Source§

impl<'a> Clone for Attrs<'a>

Source§

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

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<'a> Debug for Attrs<'a>

Source§

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

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

impl Default for Attrs<'_>

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl<'a> Freeze for Attrs<'a>

§

impl<'a> RefUnwindSafe for Attrs<'a>

§

impl<'a> Send for Attrs<'a>

§

impl<'a> Sync for Attrs<'a>

§

impl<'a> Unpin for Attrs<'a>

§

impl<'a> UnsafeUnpin for Attrs<'a>

§

impl<'a> UnwindSafe for Attrs<'a>

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,