Struct RegisteredOption 

pub struct RegisteredOption {

    pub name: String,
    pub short_description: String,
    pub long_description: String,
    pub category: String,
    pub counter: Index,
    pub advanced: bool,
    pub option_type: OptionType,
    pub default: DefaultValue,
    pub has_lower: bool,
    pub lower: Number,
    pub lower_strict: bool,
    pub has_upper: bool,
    pub upper: Number,
    pub upper_strict: bool,
    pub valid_strings: Vec<StringEntry>,
}

Mirrors RegisteredOption. Holds metadata for one option.

Fields

name: String

short_description: String

long_description: String

category: String

counter: Index

advanced: bool

option_type: OptionType

default: DefaultValue

has_lower: bool

lower: Number

lower_strict: bool

has_upper: bool

upper: Number

upper_strict: bool

valid_strings: Vec<StringEntry>

Implementations

impl RegisteredOption

pub fn is_valid_number(&self, v: Number) -> bool

Equivalent to IsValidNumberSetting — checks bounds.

pub fn is_valid_integer(&self, v: Index) -> bool

pub fn is_valid_string(&self, value: &str) -> bool

Equivalent to IsValidStringSetting. A registered entry of "*" is treated as a wildcard: any string is accepted. This mirrors upstream Ipopt’s behavior for free-form options like output_file and linear_solver_options.

pub fn canonical_string(&self, value: &str) -> Option<&str>

Returns the canonical (lowercase) form recorded at registration for the given enum value, or None if not allowed.

pub fn map_string_to_enum(&self, value: &str) -> Option<Index>

Index of value in valid_strings, used for GetEnumValue.

Trait Implementations

impl Clone for RegisteredOption

fn clone(&self) -> RegisteredOption

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RegisteredOption

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

Formats the value using the given formatter.