Struct nvim_types::Object

source · [−]

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

Expand description

Represents any type of Neovim object.

Implementations

source

impl Object

source

pub const fn nil() -> Self

Returns a new nil object.

source

pub const fn is_nil(&self) -> bool

source

pub const fn is_some(&self) -> bool

source

pub fn kind(&self) -> ObjectKind

TODO: docs

source

pub unsafe fn as_boolean_unchecked(&self) -> bool

TODO: docs

source

pub unsafe fn as_integer_unchecked(&self) -> Integer

TODO: docs

source

pub unsafe fn as_float_unchecked(&self) -> Float

TODO: docs

source

pub unsafe fn into_string_unchecked(self) -> NvimString

Extracts the inner String from the object, without checking that the object actually represents a String.

source

pub unsafe fn into_array_unchecked(self) -> Array

Extracts the inner Array from the object, without checking that the object actually represents an Array.

source

pub unsafe fn into_dict_unchecked(self) -> Dictionary

Extracts the inner Dictionary from the object, without checking that the object actually represents a Dictionary.

Trait Implementations

source

impl Clone for Object

source

fn clone(&self) -> Self

Returns a copy 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() -> Self

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

source

impl Display for Object

source

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

Formats the value using the given formatter. Read more

source

impl Drop for Object

source

fn drop(&mut self)

Executes the destructor for this type. Read more

source

impl From<&str> for Object

source

fn from(s: &str) -> Self

Converts to this type from the input type.

source

impl From<()> for Object

source

fn from(_: ()) -> Self

Converts to this type from the input type.

source

impl<T> From<Box<T, Global>> for Object where
Object: From<T>,

source

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

Converts to this type from the input type.

source

impl From<Collection<KeyValuePair>> for Object

source

fn from(dictionary: Dictionary) -> Self

Converts to this type from the input type.

source

impl From<Collection<Object>> for Object

source

fn from(array: Array) -> Self

Converts to this type from the input type.

source

impl<T> From<Cow<'_, T>> for Object where
T: Clone,
Object: From<T>,

source

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

Converts to this type from the input type.

source

impl<T> From<Option<T>> for Object where
Object: From<T>,

source

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

Converts to this type from the input type.

source

impl From<String> for Object

source

fn from(string: NvimString) -> Self

Converts to this type from the input type.

source

impl From<String> for Object

source

fn from(s: StdString) -> Self

Converts to this type from the input type.

source

impl From<bool> for Object

source

fn from(boolean: Boolean) -> Self

Converts to this type from the input type.

source

impl From<char> for Object

source

fn from(ch: char) -> Self

Converts to this type from the input type.

source

impl From<f32> for Object

source

fn from(n: f32) -> Self

Converts to this type from the input type.

source

impl From<f64> for Object

source

fn from(float: Float) -> Self

Converts to this type from the input type.

source

impl From<i16> for Object

source

fn from(i: i16) -> Self

Converts to this type from the input type.

source

impl From<i32> for Object

source

fn from(i: i32) -> Self

Converts to this type from the input type.

source

impl From<i64> for Object

source

fn from(integer: Integer) -> Self

Converts to this type from the input type.

source

impl From<i8> for Object

source

fn from(i: i8) -> Self

Converts to this type from the input type.

source

impl From<u16> for Object

source

fn from(i: u16) -> Self

Converts to this type from the input type.

source

impl From<u32> for Object

source

fn from(i: u32) -> Self

Converts to this type from the input type.

source

impl From<u8> for Object

source

fn from(i: u8) -> Self

Converts to this type from the input type.

source

impl<K, V> FromIterator<(K, V)> for Object where
NvimString: From<K>,
Object: From<V>,

source

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

Creates a value from an iterator. Read more

source

impl<T> FromIterator<T> for Object where
T: Into<Object>,

source

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

Creates a value from an iterator. Read more

source

impl PartialEq<Object> for Object

source

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

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

1.0.0 · source

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

This method tests for !=.

source

impl TryFrom<Object> for ()

type Error = FromObjectError

The type returned in the event of a conversion error.

source

fn try_from(obj: Object) -> StdResult<Self, Self::Error>

Performs the conversion.

source

impl TryFrom<Object> for Array

type Error = FromObjectError

The type returned in the event of a conversion error.

source

fn try_from(obj: Object) -> StdResult<Self, Self::Error>

Performs the conversion.

source

impl TryFrom<Object> for Boolean

type Error = FromObjectError

The type returned in the event of a conversion error.

source

fn try_from(obj: Object) -> StdResult<Self, Self::Error>

Performs the conversion.

source

impl TryFrom<Object> for Dictionary

type Error = FromObjectError

The type returned in the event of a conversion error.

source

fn try_from(obj: Object) -> StdResult<Self, Self::Error>

Performs the conversion.

source

impl TryFrom<Object> for Float

type Error = FromObjectError

The type returned in the event of a conversion error.

source

fn try_from(obj: Object) -> StdResult<Self, Self::Error>

Performs the conversion.

source

impl TryFrom<Object> for Integer

type Error = FromObjectError

The type returned in the event of a conversion error.

source

fn try_from(obj: Object) -> StdResult<Self, Self::Error>

Performs the conversion.

source

impl TryFrom<Object> for NvimString

type Error = FromObjectError

The type returned in the event of a conversion error.

source

fn try_from(obj: Object) -> StdResult<Self, Self::Error>

Performs the conversion.

source

impl TryFrom<Object> for StdString

type Error = FromObjectError

The type returned in the event of a conversion error.

source

fn try_from(obj: Object) -> StdResult<Self, Self::Error>

Performs the conversion.

source

impl TryFrom<Object> for i128

type Error = FromObjectError

The type returned in the event of a conversion error.

source

fn try_from(obj: Object) -> StdResult<Self, Self::Error>

Performs the conversion.

source

impl TryFrom<Object> for i16

type Error = FromObjectError

The type returned in the event of a conversion error.

source

fn try_from(obj: Object) -> StdResult<Self, Self::Error>

Performs the conversion.

source

impl TryFrom<Object> for i32

type Error = FromObjectError

The type returned in the event of a conversion error.

source

fn try_from(obj: Object) -> StdResult<Self, Self::Error>

Performs the conversion.

source

impl TryFrom<Object> for i8

type Error = FromObjectError

The type returned in the event of a conversion error.

source

fn try_from(obj: Object) -> StdResult<Self, Self::Error>

Performs the conversion.

source

impl TryFrom<Object> for isize

type Error = FromObjectError

The type returned in the event of a conversion error.

source

fn try_from(obj: Object) -> StdResult<Self, Self::Error>

Performs the conversion.

source

impl TryFrom<Object> for u128

type Error = FromObjectError

The type returned in the event of a conversion error.

source

fn try_from(obj: Object) -> StdResult<Self, Self::Error>

Performs the conversion.

source

impl TryFrom<Object> for u16

type Error = FromObjectError

The type returned in the event of a conversion error.

source

fn try_from(obj: Object) -> StdResult<Self, Self::Error>

Performs the conversion.

source

impl TryFrom<Object> for u32

type Error = FromObjectError

The type returned in the event of a conversion error.

source

fn try_from(obj: Object) -> StdResult<Self, Self::Error>

Performs the conversion.

source

impl TryFrom<Object> for u64

type Error = FromObjectError

The type returned in the event of a conversion error.

source

fn try_from(obj: Object) -> StdResult<Self, Self::Error>

Performs the conversion.

source

impl TryFrom<Object> for u8

type Error = FromObjectError

The type returned in the event of a conversion error.

source

fn try_from(obj: Object) -> StdResult<Self, Self::Error>

Performs the conversion.

source

impl TryFrom<Object> for usize

type Error = FromObjectError

The type returned in the event of a conversion error.

source

fn try_from(obj: Object) -> StdResult<Self, Self::Error>

Performs the conversion.

Auto Trait Implementations

impl RefUnwindSafe for Object

impl !Send for Object

impl !Sync for Object

impl Unpin for Object

impl UnwindSafe for Object

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,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · 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,

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> ToString for T where
T: Display + ?Sized,

source

default fn to_string(&self) -> String

Converts the given value to a String. Read more

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct nvim_types::Object

Implementations

impl Object

pub const fn nil() -> Self

pub const fn is_nil(&self) -> bool

pub const fn is_some(&self) -> bool

pub fn kind(&self) -> ObjectKind

pub unsafe fn as_boolean_unchecked(&self) -> bool

pub unsafe fn as_integer_unchecked(&self) -> Integer

pub unsafe fn as_float_unchecked(&self) -> Float

pub unsafe fn into_string_unchecked(self) -> NvimString

pub unsafe fn into_array_unchecked(self) -> Array

pub unsafe fn into_dict_unchecked(self) -> Dictionary

Trait Implementations

impl Clone for Object

fn clone(&self) -> Self

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

impl Debug for Object

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

impl Default for Object

fn default() -> Self

impl Display for Object

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

impl Drop for Object

fn drop(&mut self)

impl From<&str> for Object

fn from(s: &str) -> Self

impl From<()> for Object

fn from(_: ()) -> Self

impl<T> From<Box<T, Global>> for Object where Object: From<T>,

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

impl From<Collection<KeyValuePair>> for Object

fn from(dictionary: Dictionary) -> Self

impl From<Collection<Object>> for Object

fn from(array: Array) -> Self

impl<T> From<Cow<'_, T>> for Object where T: Clone, Object: From<T>,

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

impl<T> From<Option<T>> for Object where Object: From<T>,

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

impl From<String> for Object

fn from(string: NvimString) -> Self

impl From<String> for Object

fn from(s: StdString) -> Self

impl From<bool> for Object

fn from(boolean: Boolean) -> Self

impl From<char> for Object

fn from(ch: char) -> Self

impl From<f32> for Object

fn from(n: f32) -> Self

impl From<f64> for Object

fn from(float: Float) -> Self

impl From<i16> for Object

fn from(i: i16) -> Self

impl From<i32> for Object

fn from(i: i32) -> Self

impl From<i64> for Object

fn from(integer: Integer) -> Self

impl From<i8> for Object

fn from(i: i8) -> Self

impl From<u16> for Object

fn from(i: u16) -> Self

impl From<u32> for Object

fn from(i: u32) -> Self

impl From<u8> for Object

fn from(i: u8) -> Self

impl<K, V> FromIterator<(K, V)> for Object where NvimString: From<K>, Object: From<V>,

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

impl<T> FromIterator<T> for Object where T: Into<Object>,

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

impl PartialEq<Object> for Object

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

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

impl TryFrom<Object> for ()

type Error = FromObjectError

fn try_from(obj: Object) -> StdResult<Self, Self::Error>

impl TryFrom<Object> for Array

type Error = FromObjectError

fn try_from(obj: Object) -> StdResult<Self, Self::Error>

impl TryFrom<Object> for Boolean

type Error = FromObjectError

impl<T> From<Box<T, Global>> for Object where
Object: From<T>,

impl<T> From<Cow<'_, T>> for Object where
T: Clone,
Object: From<T>,

impl<T> From<Option<T>> for Object where
Object: From<T>,

impl<K, V> FromIterator<(K, V)> for Object where
NvimString: From<K>,
Object: From<V>,

impl<T> FromIterator<T> for Object where
T: Into<Object>,

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,