Struct oxi_types::Object

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

Binding to a Neovim object.

Represents any valid Neovim type.

Implementations

impl Object

pub fn nil() -> Self

Returns a new nil object.

pub fn is_nil(&self) -> bool

pub fn is_some(&self) -> bool

pub fn from_luaref(luaref: LuaRef) -> Self

pub fn kind(&self) -> ObjectKind

pub unsafe fn as_boolean_unchecked(&self) -> bool

Safety

TODO

pub unsafe fn as_integer_unchecked(&self) -> Integer

Safety

TODO

pub unsafe fn as_float_unchecked(&self) -> Float

Safety

TODO

pub unsafe fn as_luaref_unchecked(&self) -> LuaRef

Safety

TODO

pub unsafe fn into_string_unchecked(self) -> String

Safety

TODO

Extracts the contained String value without checking that the object actually contains a String.

pub unsafe fn into_array_unchecked(self) -> Array

Safety

TODO

Extracts the contained Array value without checking that the object actually contains an Array.

pub unsafe fn into_dict_unchecked(self) -> Dictionary

Safety

TODO

Extracts the contained Dictionary value without checking that the object actually contains a Dictionary.

Trait Implementations

impl Clone for Object

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Object

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

Formats the value using the given formatter.

impl Default for Object

fn default() -> Object

Returns the “default value” for a type.

impl Drop for Object

fn drop(&mut self)

Executes the destructor for this type.

impl From<&str> for Object

fn from(s: &str) -> Self

Converts to this type from the input type.

impl From<()> for Object

fn from(_: ()) -> Self

Converts to this type from the input type.

impl From<Array> for Object

fn from(array: Array) -> Self

Converts to this type from the input type.

impl<T> From<Box<T>> for Object

where Object: From<T>,

fn from(boxed: Box<T>) -> Self

Converts to this type from the input type.

impl<T> From<Cow<'_, T>> for Object

where T: Clone, Object: From<T>,

fn from(moo: Cow<'_, T>) -> Self

Converts to this type from the input type.

impl From<Cow<'_, str>> for Object

fn from(moo: Cow<'_, str>) -> Self

Converts to this type from the input type.

impl From<Dictionary> for Object

fn from(dictionary: Dictionary) -> Self

Converts to this type from the input type.

impl<A, R> From<Function<A, R>> for Object

fn from(fun: Function<A, R>) -> Self

Converts to this type from the input type.

impl<T> From<Option<T>> for Object

where Object: From<T>,

fn from(maybe: Option<T>) -> Self

Converts to this type from the input type.

impl From<String> for Object

fn from(s: String) -> Self

Converts to this type from the input type.

impl From<String> for Object

fn from(string: String) -> Self

Converts to this type from the input type.

impl From<bool> for Object

fn from(boolean: Boolean) -> Self

Converts to this type from the input type.

impl From<char> for Object

fn from(ch: char) -> Self

Converts to this type from the input type.

impl From<f32> for Object

fn from(n: f32) -> Self

Converts to this type from the input type.

impl From<f64> for Object

fn from(float: Float) -> Self

Converts to this type from the input type.

impl From<i16> for Object

fn from(i: i16) -> Self

Converts to this type from the input type.

impl From<i32> for Object

fn from(i: i32) -> Self

Converts to this type from the input type.

impl From<i64> for Object

fn from(integer: Integer) -> Self

Converts to this type from the input type.

impl From<i8> for Object

fn from(i: i8) -> Self

Converts to this type from the input type.

impl From<u16> for Object

fn from(i: u16) -> Self

Converts to this type from the input type.

impl From<u32> for Object

fn from(i: u32) -> Self

Converts to this type from the input type.

impl From<u8> for Object

fn from(i: u8) -> Self

Converts to this type from the input type.

impl<K, V> FromIterator<(K, V)> for Object

where String: From<K>, Object: From<V>,

fn from_iter<I: IntoIterator<Item = (K, V)>>(iter: I) -> Self

Creates a value from an iterator.

impl<T> FromIterator<T> for Object

where T: Into<Object>,

fn from_iter<I: IntoIterator<Item = T>>(iter: I) -> Self

Creates a value from an iterator.

impl FromObject for Object

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

impl PartialEq for Object

fn eq(&self, other: &Self) -> 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 Poppable for Object

unsafe fn pop(lstate: *mut lua_State) -> Result<Self, Error>

Pops the value at the top of the stack.

impl Pushable for Object

unsafe fn push(self, lstate: *mut lua_State) -> Result<c_int, Error>

Pushes all its values on the Lua stack, returning the number of values that it pushed.