Skip to main content

Cvc5OptionInfo

Struct Cvc5OptionInfo 

Source
#[repr(C)]
pub struct Cvc5OptionInfo {
Show 17 fields pub kind: Cvc5OptionInfoKind, pub name: *const c_char, pub num_aliases: usize, pub aliases: *mut *const c_char, pub num_no_supports: usize, pub no_supports: *mut *const c_char, pub is_set_by_user: bool, pub is_expert: bool, pub is_regular: bool, pub category: Cvc5OptionCategory, pub info_bool: Cvc5OptionInfo_BoolInfo, pub info_str: Cvc5OptionInfo_StringInfo, pub info_int: Cvc5OptionInfo_IntInfo, pub info_uint: Cvc5OptionInfo_UIntInfo, pub info_double: Cvc5OptionInfo_DoubleInfo, pub info_mode: Cvc5OptionInfo_ModeInfo, pub d_cpp_info: *mut c_void,
}
Expand description

\verbatim embed:rst:leading-asterisk Holds information about a specific option, including its name, its aliases, whether the option was explicitly set by the user, and information concerning its value. It can be obtained via :cpp:func:cvc5_get_option_info() and allows for a more detailed inspection of options than :cpp:func:cvc5_get_option(). Union member info holds any of the following alternatives:

  • Neither of the following if the option holds no value (or the value has no native type). In that case, the kind of the option will be denoted as #CVC5_OPTION_INFO_VOID.
  • Struct BoolInfo if the option is of type bool. It holds the current value and the default value of the option. Option kind is denoted as #CVC5_OPTION_INFO_BOOL.
  • Struct StringInfo if the option is of type const char*. It holds the current value and the default value of the option. Option kind is denoted as #CVC5_OPTION_INFO_STR.
  • Struct IntInfo if the option is of type int64_t. It holds the current, default, minimum and maximum value of the option. Option kind is denoted as #CVC5_OPTION_INFO_INT64.
  • Struct UIntInfo if the option is of type uint64_t. It holds the current, default, minimum and maximum value of the option. Option kind is denoted as #CVC5_OPTION_INFO_UINT64.
  • Struct DoubleInfo if the option is of type double. It holds the current, default, minimum and maximum value of the option. Option kind is denoted as #CVC5_OPTION_INFO_DOUBLE.
  • Struct ModeInfo if the option has modes. It holds the current and default valuesof the option, as well as a list of valid modes. Option kind is denoted as #CVC5_OPTION_INFO_MODES.

\endverbatim

@note A typedef alias with the same name is also available for convenience.

Fields§

§kind: Cvc5OptionInfoKind

The kind of the option info.

§name: *const c_char

The option name

§num_aliases: usize

The number of option name aliases

§aliases: *mut *const c_char

The option name aliases

§num_no_supports: usize

The number of unsupported features

§no_supports: *mut *const c_char

The unsupported features

§is_set_by_user: bool

True if the option was explicitly set by the user

§is_expert: bool

True if the option is an expert option @warning This field is deprecated and replaced by category. It will be removed in a future release.

§is_regular: bool

True if the option is a regular option @warning This field is deprecated and replaced by category. It will be removed in a future release.

§category: Cvc5OptionCategory

The category of this option.

§info_bool: Cvc5OptionInfo_BoolInfo§info_str: Cvc5OptionInfo_StringInfo§info_int: Cvc5OptionInfo_IntInfo§info_uint: Cvc5OptionInfo_UIntInfo§info_double: Cvc5OptionInfo_DoubleInfo§info_mode: Cvc5OptionInfo_ModeInfo§d_cpp_info: *mut c_void

The associated C++ info. For internal use, only.

Trait Implementations§

Source§

impl Clone for Cvc5OptionInfo

Source§

fn clone(&self) -> Cvc5OptionInfo

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 Cvc5OptionInfo

Source§

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

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

impl Default for Cvc5OptionInfo

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Copy for Cvc5OptionInfo

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, 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.