Struct nvim_oxi_api::types::OptionInfos

#[non_exhaustive]
pub struct OptionInfos {
    pub allows_duplicates: bool,
    pub commalist: bool,
    pub default: Object,
    pub flaglist: bool,
    pub global_local: bool,
    pub last_set_chan: i64,
    pub last_set_linenr: usize,
    pub last_set_sid: i32,
    pub name: String,
    pub scope: OptionScope,
    pub shortname: String,
    pub was_set: bool,
}

Informations related to an option. Unlike in the Lua API, the type field is omitted because it’s included in the definition of default.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

allows_duplicates: bool

TODO: docs

commalist: bool

List of comma-separated values.

default: Object

The default value for the option.

flaglist: bool

TODO: docs

global_local: bool

Whether a window or buffer option also has a global value.

last_set_chan: i64

Channel id where the option was set (0 for local).

last_set_linenr: usize

The line number where the option was set.

last_set_sid: i32

Last set script id (if any).

name: String

Name of the option (like "filetype").

scope: OptionScope

Scope of the option.

shortname: String

Shortened name of the option (like "ft").

was_set: bool

Whether the option was set.

Trait Implementations

impl Clone for OptionInfos

fn clone(&self) -> OptionInfos

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for OptionInfos

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for OptionInfos

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl FromObject for OptionInfos

fn from_object(obj: Object) -> Result<Self, Error>

impl PartialEq for OptionInfos

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

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for OptionInfos