Skip to main content

Highlight

Enum Highlight 

Source
pub enum Highlight {
Show 16 variants Black, Blue, Cyan, DarkBlue, DarkCyan, DarkGray, DarkGreen, DarkMagenta, DarkRed, DarkYellow, Green, LightGray, Magenta, Red, White, Yellow,
}
Expand description

A run’s text highlight color (<w:highlight w:val="..">, CT_Highlight, ST_HighlightColor) — a fixed palette of “highlighter” colors applied as a background behind a run’s text, distinct from Run.color (an arbitrary literal RGB text color) and from an arbitrary shaded background fill (w:shd, not modeled).

ST_HighlightColor also defines the value "none", explicitly clearing any inherited highlighting — not modeled as its own variant here, since Run.highlight: Option<Highlight> already expresses “no highlight” via None (omitting w:highlight entirely achieves the same visual result for a run with nothing to inherit from).

Variants§

§

Black

§

Blue

§

Cyan

§

DarkBlue

§

DarkCyan

§

DarkGray

§

DarkGreen

§

DarkMagenta

§

DarkRed

§

DarkYellow

§

Green

§

LightGray

§

Magenta

§

Red

§

White

§

Yellow

Implementations§

Source§

impl Highlight

Source

pub fn attribute_value(self) -> &'static str

This highlight’s w:highlight/val value (ST_HighlightColor).

Source

pub fn from_attribute_value(value: &str) -> Option<Highlight>

Parses a w:highlight/val value (ST_HighlightColor) back into a Highlight, or None for "none" or an unrecognized value.

Trait Implementations§

Source§

impl Clone for Highlight

Source§

fn clone(&self) -> Highlight

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for Highlight

Source§

impl Debug for Highlight

Source§

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

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

impl Eq for Highlight

Source§

impl PartialEq for Highlight

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Highlight

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

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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

Source§

type Output = T

Should always be Self
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.