Skip to main content

Color

Enum Color 

Source
pub enum Color {
    Transparent,
    Gray(f32),
    Rgb(f32, f32, f32),
    Cmyk(f32, f32, f32, f32),
}
Expand description

A colour in whichever device space its component count named.

Variants§

§

Transparent

No colour: the caller emits no colour operator at all.

§

Gray(f32)

DeviceGray.

§

Rgb(f32, f32, f32)

DeviceRGB.

§

Cmyk(f32, f32, f32, f32)

DeviceCMYK.

Implementations§

Source§

impl Color

Source

pub fn from_array(array: &Array) -> Color

Reads a colour array, dispatching purely on its length.

Components come through the non-resolving numeric accessor, so a missing or mistyped element reads as 0.0 rather than rejecting the array.

use pdfrum_doc::color::Color;
use pdfrum_object::Array;

let grey = Array::of([0.5_f32]);
assert_eq!(Color::from_array(&grey), Color::Gray(0.5));
// An empty array says "no colour", not "damaged".
assert_eq!(Color::from_array(&Array::new()), Color::Transparent);
Source

pub fn annot_rgb_bytes(self) -> (u32, u32, u32)

Component-wise equality within 1e-4.

Deliberately not PartialEq: the derived one stays exact so a test The RGB bytes the --annot dump prints.

CMYK converts multiplicatively (255·(1−c)·(1−k)), which is not the formula Color::mk_rgb_bytes uses for the same colour in a widget’s /MK dictionary. Both exist upstream; keeping them named apart is the only defence against unifying them.

Negative components saturate at zero rather than wrapping, which is what the C++’s float-to-unsigned conversion does in practice.

use pdfrum_doc::color::Color;

assert_eq!(Color::Rgb(1.0, 0.0, 0.5).annot_rgb_bytes(), (255, 0, 127));
// CMYK converts multiplicatively here, not the way `/MK` colours do.
assert_eq!(Color::Cmyk(0.0, 0.0, 0.0, 0.0).annot_rgb_bytes(), (255, 255, 255));

Trait Implementations§

Source§

impl Clone for Color

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 Color

Source§

impl Debug for Color

Source§

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

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

impl Default for Color

Source§

fn default() -> Self

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

impl PartialEq for Color

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 Color

Auto Trait Implementations§

§

impl Freeze for Color

§

impl RefUnwindSafe for Color

§

impl Send for Color

§

impl Sync for Color

§

impl Unpin for Color

§

impl UnsafeUnpin for Color

§

impl UnwindSafe for Color

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.