Skip to main content

ColorRule

Struct ColorRule 

Source
pub struct ColorRule {
    pub map: Colormap,
    pub range: (f32, f32),
    pub below: OutOfRange,
    pub above: OutOfRange,
    pub center: Option<f32>,
    pub base: [u8; 4],
    pub nan: [u8; 4],
}
Expand description

How a scalar field is turned into colours.

Fields§

§map: Colormap

The colormap.

§range: (f32, f32)

(lo, hi): values mapped onto the colormap; lo < hi, both finite.

§below: OutOfRange

Colour rule for values below lo (and -∞).

§above: OutOfRange

Colour rule for values above hi (and +∞).

§center: Option<f32>

A value pinned to the middle of the colormap, within range.

§base: [u8; 4]

The colour of OutOfRange::Base.

§nan: [u8; 4]

The colour of NaN values.

Implementations§

Source§

impl ColorRule

Source

pub fn validate(&self) -> Result<(), FieldsError>

Checks the rule.

§Errors

FieldsError::InvalidInput if range has a non-finite end or lo >= hi, if center is non-finite or outside range, or if a custom colormap has fewer than two stops or stop positions that are not finite, outside [0, 1] or not strictly increasing.

Trait Implementations§

Source§

impl Clone for ColorRule

Source§

fn clone(&self) -> ColorRule

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 Debug for ColorRule

Source§

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

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

impl PartialEq for ColorRule

Source§

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

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