Skip to main content

CombineOp

Enum CombineOp 

Source
#[non_exhaustive]
pub enum CombineOp { Replace, Add, }
Expand description

The combine operation for an overlay composition (composition_rule = 0x02).

Selects how a correction member’s value at a covered index combines with the value shown by lower-precedence members (down to the base).

§Examples

use hurray_core::layout::CombineOp;

assert_eq!(CombineOp::Replace.wire_byte(), 0x01);
assert_eq!(CombineOp::Add.wire_byte(), 0x02);
assert_eq!(CombineOp::from_wire(0x01), Some(CombineOp::Replace));
assert_eq!(CombineOp::from_wire(0x00), None);

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

Replace

Last-wins: the topmost (latest-emitted) member covering an index wins within its box, and the base shows through elsewhere. Wire byte 0x01.

§

Add

The value at an index is the base value plus the sum of all covering corrections’ values at that index. Wire byte 0x02.

Implementations§

Source§

impl CombineOp

Source

pub fn wire_byte(self) -> u8

Returns the wire byte for this combine operation.

§Examples
use hurray_core::layout::CombineOp;

assert_eq!(CombineOp::Replace.wire_byte(), 0x01);
Source

pub fn from_wire(byte: u8) -> Option<Self>

Constructs a CombineOp from its wire byte. Returns None for any value other than 0x01 or 0x02.

§Examples
use hurray_core::layout::CombineOp;

assert_eq!(CombineOp::from_wire(0x02), Some(CombineOp::Add));
assert_eq!(CombineOp::from_wire(0xFF), None);

Trait Implementations§

Source§

impl Clone for CombineOp

Source§

fn clone(&self) -> CombineOp

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 CombineOp

Source§

impl Debug for CombineOp

Source§

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

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

impl Eq for CombineOp

Source§

impl Hash for CombineOp

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for CombineOp

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for CombineOp

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.