Struct Object

#[repr(C)]pub struct Object {
    ty: ObjectKind,
    data: ObjectData,
}

Expand description

Binding to a Neovim object.

Represents any valid Neovim type.

Fields§

§ty: ObjectKind§data: ObjectData

Implementations§

§

impl Object

pub fn nil() -> Object

Returns a new nil object.

pub fn is_nil(&self) -> bool

pub fn is_some(&self) -> bool

pub fn from_luaref(luaref: i32) -> Object

pub fn kind(&self) -> ObjectKind

pub unsafe fn as_boolean_unchecked(&self) -> bool

Returns the boolean stored in this Object.

This is a zero-cost method that directly accesses the underlying value without performing any runtime checks.

§Safety

This Object’s ObjectKind must be a Boolean. Calling this method on an Object with any other kind may result in undefined behavior.

pub unsafe fn as_boolean_unchecked_mut(&mut self) -> &mut bool

Returns a mutable reference to the boolean stored in this Object.

This is a zero-cost method that directly accesses the underlying value without performing any runtime checks.

§Safety

This Object’s ObjectKind must be a Boolean. Calling this method on an Object with any other kind may result in undefined behavior.

pub unsafe fn as_integer_unchecked(&self) -> i64

Returns the integer stored in this Object.

This is a zero-cost method that directly accesses the underlying value without performing any runtime checks.

§Safety

This Object’s ObjectKind must be one of Integer, Buffer, Window, or TabPage. Calling this method on an Object with any other kind may result in undefined behavior.

pub unsafe fn as_integer_unchecked_mut(&mut self) -> &mut i64

Returns a mutable reference to the integer stored in this Object.

This is a zero-cost method that directly accesses the underlying value without performing any runtime checks.

§Safety

This Object’s ObjectKind must be one of Integer, Buffer, Window, or TabPage. Calling this method on an Object with any other kind may result in undefined behavior.

pub unsafe fn as_float_unchecked(&self) -> f64

Returns the float stored in this Object.

This is a zero-cost method that directly accesses the underlying value without performing any runtime checks.

§Safety

This Object’s ObjectKind must be a Float. Calling this method on an Object with any other kind may result in undefined behavior.

pub unsafe fn as_float_unchecked_mut(&mut self) -> &mut f64

Returns a mutable reference to the float stored in this Object.

This is a zero-cost method that directly accesses the underlying value without performing any runtime checks.

§Safety

This Object’s ObjectKind must be a Float. Calling this method on an Object with any other kind may result in undefined behavior.

pub unsafe fn as_luaref_unchecked(&self) -> i32

Returns the Lua reference stored in this Object.

This is a zero-cost method that directly accesses the underlying value without performing any runtime checks.

§Safety

This Object’s ObjectKind must be a LuaRef. Calling this method on an Object with any other kind may result in undefined behavior.

pub unsafe fn as_luaref_unchecked_mut(&mut self) -> &mut i32

Returns a mutable reference to the Lua reference stored in this Object.

This is a zero-cost method that directly accesses the underlying value without performing any runtime checks.

§Safety

This Object’s ObjectKind must be a LuaRef. Calling this method on an Object with any other kind may result in undefined behavior.

pub unsafe fn as_nvim_str_unchecked(&self) -> NvimStr<'_>

Returns a reference to the string stored in this Object.

This is a zero-cost method that directly accesses the underlying value without performing any runtime checks.

§Safety

This Object’s ObjectKind must be a String. Calling this method on an Object with any other kind may result in undefined behavior.

pub unsafe fn into_string_unchecked(self) -> String

Returns the string stored in this Object.

This is a zero-cost method that directly accesses the underlying value without performing any runtime checks.

§Safety

This Object’s ObjectKind must be a String. Calling this method on an Object with any other kind may result in undefined behavior.

pub unsafe fn as_array_unchecked(&self) -> &Array

Returns a reference to the array stored in this Object.

This is a zero-cost method that directly accesses the underlying value without performing any runtime checks.

§Safety

This Object’s ObjectKind must be an Array. Calling this method on an Object with any other kind may result in undefined behavior.

pub unsafe fn as_array_unchecked_mut(&mut self) -> &mut Array

Returns a mutable reference to the array stored in this Object.

This is a zero-cost method that directly accesses the underlying value without performing any runtime checks.

§Safety

This Object’s ObjectKind must be an Array. Calling this method on an Object with any other kind may result in undefined behavior.

pub unsafe fn into_array_unchecked(self) -> Array

Returns the array stored in this Object.

This is a zero-cost method that directly accesses the underlying value without performing any runtime checks.

§Safety

This Object’s ObjectKind must be an Array. Calling this method on an Object with any other kind may result in undefined behavior.

pub unsafe fn as_dictionary_unchecked(&self) -> &Dictionary

Returns a reference to the dictionary stored in this Object.

This is a zero-cost method that directly accesses the underlying value without performing any runtime checks.

§Safety

This Object’s ObjectKind must be a Dictionary. Calling this method on an Object with any other kind may result in undefined behavior.

pub unsafe fn as_dictionary_unchecked_mut(&mut self) -> &mut Dictionary

Returns a mutable reference to the dictionary stored in this Object.

This is a zero-cost method that directly accesses the underlying value without performing any runtime checks.

§Safety

This Object’s ObjectKind must be a Dictionary. Calling this method on an Object with any other kind may result in undefined behavior.

pub unsafe fn into_dictionary_unchecked(self) -> Dictionary

Returns the dictionary stored in this Object.

This is a zero-cost method that directly accesses the underlying value without performing any runtime checks.

§Safety

This Object’s ObjectKind must be a Dictionary. Calling this method on an Object with any other kind may result in undefined behavior.

Trait Implementations§

§

impl Clone for Object

§

fn clone(&self) -> Object

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

§

impl Debug for Object

§

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

Formats the value using the given formatter. Read more

§

impl Default for Object

§

fn default() -> Object

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

§

impl<'de> Deserialize<'de> for Object

§

fn deserialize<D>( deserializer: D, ) -> Result<Object, <D as Deserializer<'de>>::Error>
where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

§

impl Drop for Object

§

fn drop(&mut self)

Executes the destructor for this type. Read more

§