Guide API
Skip to main content

ClusterKind

Enum ClusterKind 

Source
pub enum ClusterKind {
    CheckBoxes,
    RadioButtons,
    MultiCheckBoxes {
        sel_range: u8,
        flags: u16,
        states: String,
    },
}
Expand description

Selects which of the three cluster behaviors the Cluster engine applies.

Pass a ClusterKind to Cluster::new when you need the raw engine. In practice, call the named constructors instead: CheckBoxes::new → ClusterKind::CheckBoxes, RadioButtons::new → ClusterKind::RadioButtons, MultiCheckBoxes::new → ClusterKind::MultiCheckBoxes.

Variants§

§

CheckBoxes

Check boxes — value is a bitmask (bit item set ⇔ item checked). Box [ ], markers " X" (idx 0 / 1).

§

RadioButtons

Radio buttons — value is the selected item index. Box ( ), markers " •" (idx 0 / 1; CP437 0x07 bullet → U+2022). Moving the selection sets value = item.

§

MultiCheckBoxes

Multi-state check boxes — value packs an n-bit state per item. Box [ ], markers from states (idx = the item’s current state).

Use this variant (or MultiCheckBoxes::new) when each option can be in one of three or more named states. The three fields together determine how many bits each item occupies in value and how those bits are drawn.

Fields

§sel_range: u8

Number of distinct states each item cycles through (must be ≤ the number of characters in states). Press / click / hotkey advances an item’s state by 1, wrapping back to 0 after sel_range - 1.

§flags: u16

Packed item-layout descriptor — low byte (flags & 0xff) is the per-item bit mask and high byte (flags >> 8) is the per-item bit-shift stride. Example: 0x0203 = 2-bit items (mask 0x03, stride 2), supporting up to 4 states and up to 16 items in a u32.

§states: String

Marker glyphs for each state value; character at index s is drawn when an item is in state s. Must have at least sel_range characters — indices beyond the string length display a space.

Trait Implementations§

Source§

impl Clone for ClusterKind

Source§

fn clone(&self) -> ClusterKind

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 ClusterKind

Source§

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

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

impl Eq for ClusterKind

Source§

impl PartialEq for ClusterKind

Source§

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

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> CustomValue for T
where T: Any + Debug,

Source§

fn as_any_rc(self: Rc<T>) -> Rc<dyn Any>

Upcast Rc<Self> to Rc<dyn Any> so FieldValue::as_custom / FieldValue::value_as can downcast.
§

impl<T> Downcast for T
where T: Any,

§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync> ⓘ

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
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.