Skip to main content

CodeEditorColors

Struct CodeEditorColors 

Source
pub struct CodeEditorColors {
    pub container: Option<ColorRole>,
    pub gutter: Option<ColorRole>,
    pub line_number: Option<ColorRole>,
    pub current_line_number: Option<ColorRole>,
    pub current_line: Option<ColorRole>,
}
Expand description

The colours of an editor’s own parts, each a role of the theme.

A part that is not named keeps the colour the design system gives it, so an application can set the container and the gutter and leave the rest. Roles and never literals: the colours follow the theme from light to dark like every other colour here.

Fields§

§container: Option<ColorRole>

What the text sits on.

§gutter: Option<ColorRole>

What the line numbers sit on.

§line_number: Option<ColorRole>§current_line_number: Option<ColorRole>

The number of the line the caret is on.

§current_line: Option<ColorRole>

The band behind the line the caret is on.

Implementations§

Source§

impl CodeEditorColors

Source

pub const fn new() -> Self

Every part left to the design system.

Source

pub const fn container(self, role: ColorRole) -> Self

Source

pub const fn gutter(self, role: ColorRole) -> Self

Source

pub const fn line_number(self, role: ColorRole) -> Self

Source

pub const fn current_line_number(self, role: ColorRole) -> Self

Source

pub const fn current_line(self, role: ColorRole) -> Self

Source

pub fn is_empty(&self) -> bool

Whether every part is left to the design system, in which case there is nothing to send.

Source

pub fn to_bytes(&self) -> [u8; 12]

The record as it travels in the CodeEditorColors property.

Source

pub fn from_bytes(bytes: &[u8]) -> Option<Self>

The record read back. None where the bytes are not one whole record or name a role this side does not know, which is what the Renderer refuses too.

Trait Implementations§

Source§

impl Clone for CodeEditorColors

Source§

fn clone(&self) -> Self

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 CodeEditorColors

Source§

impl Debug for CodeEditorColors

Source§

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

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

impl Default for CodeEditorColors

Source§

fn default() -> Self

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

impl Eq for CodeEditorColors

Source§

impl PartialEq for CodeEditorColors

Source§

fn eq(&self, other: &Self) -> 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 CodeEditorColors

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<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> 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 = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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.