Skip to main content

Style

Struct Style 

Source
pub struct Style {
    pub fg: Option<PackedRgba>,
    pub bg: Option<PackedRgba>,
    pub attrs: Option<StyleFlags>,
    pub underline_color: Option<PackedRgba>,
}
Expand description

Unified styling type with CSS-like cascading semantics.

§Design Rationale

  • Option fields allow inheritance (None = inherit from parent)
  • Explicit masks track which properties are intentionally set
  • Copy + small size for cheap passing
  • Builder pattern for ergonomic construction

§Example

use ftui_style::{Style, StyleFlags};
use ftui_render::cell::PackedRgba;

let style = Style::new()
    .fg(PackedRgba::rgb(255, 0, 0))
    .bg(PackedRgba::rgb(0, 0, 0))
    .bold()
    .underline();

Fields§

§fg: Option<PackedRgba>

Foreground color (text color).

§bg: Option<PackedRgba>

Background color.

§attrs: Option<StyleFlags>

Text attributes (bold, italic, etc.).

§underline_color: Option<PackedRgba>

Underline color (separate from fg for flexibility).

Implementations§

Source§

impl Style

Source

pub const fn new() -> Self

Create an empty style (all properties inherit).

Source

pub fn fg<C: Into<PackedRgba>>(self, color: C) -> Self

Set foreground color.

Source

pub fn bg<C: Into<PackedRgba>>(self, color: C) -> Self

Set background color.

Source

pub fn bold(self) -> Self

Add bold attribute.

Source

pub fn italic(self) -> Self

Add italic attribute.

Source

pub fn underline(self) -> Self

Add underline attribute.

Source

pub fn dim(self) -> Self

Add dim attribute.

Source

pub fn reverse(self) -> Self

Add reverse video attribute.

Source

pub fn strikethrough(self) -> Self

Add strikethrough attribute.

Add blink attribute.

Source

pub fn hidden(self) -> Self

Add hidden attribute.

Source

pub fn double_underline(self) -> Self

Add double underline attribute.

Source

pub fn curly_underline(self) -> Self

Add curly underline attribute.

Source

pub const fn underline_color(self, color: PackedRgba) -> Self

Set underline color.

Source

pub const fn attrs(self, attrs: StyleFlags) -> Self

Set attributes directly.

Source

pub fn merge(&self, parent: &Style) -> Style

Cascade merge: Fill in None fields from parent.

child.merge(parent) returns a style where child’s Some values take precedence, and parent fills in any None values.

For attributes, the flags are combined (OR operation) so both parent and child attributes apply.

§Example
use ftui_style::Style;
use ftui_render::cell::PackedRgba;

let parent = Style::new().fg(PackedRgba::rgb(255, 0, 0)).bold();
let child = Style::new().bg(PackedRgba::rgb(0, 0, 255));
let merged = child.merge(&parent);
// merged has: fg=RED (from parent), bg=BLUE (from child), bold (from parent)
Source

pub fn patch(&self, child: &Style) -> Style

Patch merge: Override parent with child’s Some values.

parent.patch(&child) returns a style where child’s Some values replace parent’s values.

This is the inverse perspective of merge().

Source

pub const fn is_empty(&self) -> bool

Check if this style has any properties set.

Source

pub fn has_attr(&self, flag: StyleFlags) -> bool

Check if a specific attribute is set.

Trait Implementations§

Source§

impl Clone for Style

Source§

fn clone(&self) -> Style

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 Style

Source§

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

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

impl Default for Style

Source§

fn default() -> Style

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

impl Hash for Style

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for Style

Source§

fn eq(&self, other: &Style) -> 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.
Source§

impl Copy for Style

Source§

impl Eq for Style

Source§

impl StructuralPartialEq for Style

Auto Trait Implementations§

§

impl Freeze for Style

§

impl RefUnwindSafe for Style

§

impl Send for Style

§

impl Sync for Style

§

impl Unpin for Style

§

impl UnwindSafe for Style

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> Instrument for T

Source§

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

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

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

impl<T> WithSubscriber for T

Source§

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

fn with_current_subscriber(self) -> WithDispatch<Self>

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