Struct Style

pub struct Style {
    pub priority: u16,
    pub fg_color: Option<u32>,
    pub bg_color: Option<u32>,
    pub weight: Option<u16>,
    pub underline: Option<bool>,
    pub italic: Option<bool>,
}

A mergeable style. All values except priority are optional.

Note: A None value represents the absense of preference; in the case of boolean options, Some(false) means that this style will override a lower priority value in the same field.

Fields

priority: u16

The priority of this style, in the range (0, 1000). Used to resolve conflicting fields when merging styles. The higher priority wins.

fg_color: Option<u32>

The foreground text color, in ARGB.

bg_color: Option<u32>

The background text color, in ARGB.

weight: Option<u16>

The font-weight, in the range 100-900, interpreted like the CSS font-weight property.

underline: Option<bool>

italic: Option<bool>

Implementations

impl Style

pub fn from_syntect_style_mod(style: &SynStyleModifier) -> Self

Creates a new Style by converting from a Syntect::StyleModifier.

pub fn new<O32, O16, OB>( priority: u16, fg_color: O32, bg_color: O32, weight: O16, underline: OB, italic: OB, ) -> Self

where O32: Into<Option<u32>>, O16: Into<Option<u16>>, OB: Into<Option<bool>>,

pub fn default_for_theme(theme: &Theme) -> Self

Returns the default style for the given Theme.

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

Creates a new style by combining attributes of self and other. If both styles define an attribute, the highest priority wins; other wins in the case of a tie.

Note: when merging multiple styles, apply them in increasing priority.

pub fn to_json(&self, id: usize) -> Value

Encode this Style, setting the id property.

Note: this should only be used when sending the def_style RPC.

Trait Implementations

impl Clone for Style

fn clone(&self) -> Style

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Style

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

Formats the value using the given formatter.

impl Default for Style

fn default() -> Style

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Style

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for Style

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Style

fn eq(&self, other: &Style) -> 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 Serialize for Style

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Style

impl StructuralPartialEq for Style