Struct Object

Source

#[repr(C)]
pub struct Object { /* private fields */ }

Expand description

Binding to a Neovim object.

Represents any valid Neovim type.

Implementations§

Source §

impl Object

Source

pub fn nil() -> Self

Returns a new nil object.

Source

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.

Source

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.

Source

pub unsafe fn as_integer_unchecked(&self) -> Integer

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.

Source

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

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.

Source

pub unsafe fn as_float_unchecked(&self) -> Float

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.

Source

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

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.

Source

pub unsafe fn as_luaref_unchecked(&self) -> LuaRef

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.

Source

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

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.

Source

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.

Source

pub unsafe fn into_string_unchecked(self) -> NvimString

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.

Source

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.

Source

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.

Source

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.

Source

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.

Source

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.

Source

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§

Source §

impl Clone for Object

Source §

fn clone(&self) -> Self

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 Object

Source §

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

Formats the value using the given formatter. Read more

Source §

impl Default for Object

Source §

fn default() -> Object

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

Source §

impl Drop for Object

Source §

fn drop(&mut self)

Executes the destructor for this type. Read more

Source §