Struct CommonHighlight 

#[non_exhaustive]
pub struct CommonHighlight {
    pub style: Style,
    pub style_unfocused: Style,
    pub symbol: LineStatic,
}

Prop Store for very common highlight props.

This structure helps to have a common way to handle the “very common” highlight properties, reducing boilerplate and potential mis-matches.

Additionally, using this over Props, saves on indirection and heap-size. On usage (usually on view), it also saves on unwraps or “defaulting”

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

style: Style

The main style to patch CommonProps::style with for the currently active element.

style_unfocused: Style

A Style to patch on-top of style when unfocused.

symbol: LineStatic

The symbol to use to indicate the currently selected element.

Implementations

impl CommonHighlight

pub fn set(&mut self, attr: Attribute, value: AttrValue) -> Option<AttrValue>

Try to set a given Attribute. Returns Some if the value is unhandled. None if handled.

pub fn get<'a>(&'a self, attr: Attribute) -> Option<AttrValueRef<'a>>

Try to get a given Attribute.

pub fn get_for_query<'a>(&'a self, attr: Attribute) -> Option<QueryResult<'a>>

Try to get a given Attribute as a type compatible with Component::query.

pub fn get_symbol(&self) -> Option<Line<'_>>

Get the set highlight symbol as its own Line instance, but referencing the existing data.

pub fn get_style(&self, normal_style: Style) -> Style

Get the patched highlight style.

pub fn get_style_focus(&self, normal_style: Style, focus: bool) -> Style

Get the patched highlight style with focused or unfocused style.

Trait Implementations

impl Clone for CommonHighlight

fn clone(&self) -> CommonHighlight

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CommonHighlight

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

Formats the value using the given formatter.

impl Default for CommonHighlight

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for CommonHighlight

fn eq(&self, other: &CommonHighlight) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl Eq for CommonHighlight

impl StructuralPartialEq for CommonHighlight