Skip to main content

OptionValue

Enum OptionValue 

Source
pub enum OptionValue {
    Bool(bool),
    Integer(i64),
    String(String),
    Choice {
        value: String,
        choices: Vec<String>,
    },
}
Expand description

Type-safe option value.

This is the core value type for editor options. Each variant maps to a common configuration pattern:

  • Bool: Toggle settings (number, wrap, etc.)
  • Integer: Numeric settings (tabwidth, scrolloff)
  • String: Free-form text (theme name, paths)
  • Choice: Enum-like selection from predefined values

Variants§

§

Bool(bool)

Boolean on/off option (e.g., number, relativenumber)

§

Integer(i64)

Integer option (e.g., tabwidth, scrolloff)

§

String(String)

String option (e.g., theme, signcolumn)

§

Choice

Choice option with predefined valid values.

The choices field stores all valid values for validation.

Fields

§value: String

Current selected value

§choices: Vec<String>

All valid choices (for validation and completion)

Implementations§

Source§

impl OptionValue

Source

pub const fn bool(value: bool) -> Self

Create a boolean value.

Source

pub const fn int(value: i64) -> Self

Create an integer value.

Source

pub fn string(value: impl Into<String>) -> Self

Create a string value.

Source

pub fn choice(value: impl Into<String>, choices: Vec<String>) -> Self

Create a choice value.

§Panics

Panics if choices is empty or if value is not in choices.

Source

pub const fn as_bool(&self) -> Option<bool>

Try to get as boolean.

Source

pub const fn as_int(&self) -> Option<i64>

Try to get as integer.

Source

pub fn as_str(&self) -> Option<&str>

Try to get as string reference.

Source

pub const fn type_name(&self) -> &'static str

Get the type name for error messages.

Source

pub const fn same_type(&self, other: &Self) -> bool

Check if this value has the same type as another.

Trait Implementations§

Source§

impl Clone for OptionValue

Source§

fn clone(&self) -> OptionValue

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for OptionValue

Source§

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

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

impl Display for OptionValue

Source§

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

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

impl PartialEq for OptionValue

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · 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 Eq for OptionValue

Source§

impl StructuralPartialEq for OptionValue

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> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. 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.