Enum MemberRole 

#[non_exhaustive]
pub enum MemberRole {
    Correction,
    Base,
}

The role a member plays within an overlay composite.

v1.0 defines only Correction and Base; wire values 0x02–0xFF are RESERVED for a future tombstone kind (see docs/spec/layouts/composite.md § Deferred) and are rejected by MemberRole::from_wire.

Examples

use hurray_core::descriptor::MemberRole;

assert_eq!(MemberRole::Correction.wire_byte(), 0x00);
assert_eq!(MemberRole::Base.wire_byte(), 0x01);
assert_eq!(MemberRole::from_wire(0x01).unwrap(), MemberRole::Base);
assert!(MemberRole::from_wire(0x02).is_err());

Variants (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.

Correction

A scattered correction applied within its box. Wire byte 0x00.

Base

The base member spanning the whole index space. Wire byte 0x01.

Implementations

impl MemberRole

pub fn wire_byte(self) -> u8

Returns the wire byte for this role.

Examples

use hurray_core::descriptor::MemberRole;

assert_eq!(MemberRole::Base.wire_byte(), 0x01);

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

Constructs a MemberRole from its wire byte.

Errors

Returns Error::InvalidMemberRole for any byte other than 0x00 or 0x01.

Examples

use hurray_core::{Error, descriptor::MemberRole};

assert_eq!(MemberRole::from_wire(0x00).unwrap(), MemberRole::Correction);
assert!(matches!(MemberRole::from_wire(0xFF), Err(Error::InvalidMemberRole(0xFF))));

Trait Implementations

impl Clone for MemberRole

fn clone(&self) -> MemberRole

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for MemberRole

impl Debug for MemberRole

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

Formats the value using the given formatter.

impl Eq for MemberRole

impl Hash for MemberRole

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for MemberRole

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for MemberRole