Struct EntryFlags 

pub struct EntryFlags(pub u8);

Per-entry flag bits. Bit assignments are stable across IDFv1.

Tuple Fields

0: u8

Implementations

impl EntryFlags

pub const BLACKLIST: u8

pub const CURATED_OVERRIDE: u8

pub const USER_ADDED: u8

pub const ENGINE_TAG_MASK: u8 = 0b1110_0000

Bits 5-7 carry an engine-specific 3-bit enum payload (0-7). For wubi entries (added v1.4.7 sub-phase A4 step 2): the inputx_wubi::Layer enum index, so cement-side fills can recover (word, layer, raw_freq) tuples without re-reading the facade dict. For non-wubi engines it stays zero. Decoders querying this should pair it with the IDF’s engine_kind header byte; the field is otherwise just opaque bits.

pub const ENGINE_TAG_SHIFT: u8 = 5

pub fn is_blacklisted(self) -> bool

pub fn is_curated_override(self) -> bool

pub fn is_user_added(self) -> bool

pub fn engine_tag(self) -> u8

Return the 3-bit engine-specific tag (bits 5-7). For wubi this is the Layer enum’s as_index().

pub fn with_engine_tag(self, tag: u8) -> Self

Set the 3-bit engine-specific tag while preserving the other bits. tag is clamped to 3 bits (& 0b111); callers passing out-of-range values lose the upper bits silently — keep the caller’s enum strictly ≤ 7.

Trait Implementations

impl Clone for EntryFlags

fn clone(&self) -> EntryFlags

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EntryFlags

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

Formats the value using the given formatter.

impl Default for EntryFlags

fn default() -> EntryFlags

Returns the “default value” for a type.

impl PartialEq for EntryFlags

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

impl Eq for EntryFlags

impl StructuralPartialEq for EntryFlags