Struct ExternalPtr

#[repr(transparent)]
pub struct ExternalPtr<T> {
    pub(crate) robj: Robj,
    _marker: PhantomData<T>,
}

Wrapper for creating R objects containing any Rust object.

use extendr_api::prelude::*;
test! {
    let extptr = ExternalPtr::new(1);
    assert_eq!(*extptr, 1);
    let robj : Robj = extptr.into();
    let extptr2 : ExternalPtr<i32> = robj.try_into().unwrap();
    assert_eq!(*extptr2, 1);
}

Fields

robj: Robj

This is the contained Robj.

_marker: PhantomData<T>

This is a zero-length object that holds the type of the object.

Implementations

impl<T: 'static> ExternalPtr<T>

pub fn new(val: T) -> Self

Construct an external pointer object from any type T. In this case, the R object owns the data and will drop the Rust object when the last reference is removed via register_c_finalizer.

An ExternalPtr behaves like a Box except that the information is tracked by a R object.

pub fn tag(&self) -> Robj

Get the “tag” of an external pointer. This is the type name in the common case.

pub fn protected(&self) -> Robj

Get the “protected” field of an external pointer. This is NULL in the common case.

pub fn addr(&self) -> &T

Get the “address” field of an external pointer. Normally, we will use Deref to do this.

Panics

When the underlying pointer is C NULL.

pub fn addr_mut(&mut self) -> &mut T

Get the “address” field of an external pointer as a mutable reference. Normally, we will use DerefMut to do this.

Panics

When the underlying pointer is C NULL.

pub fn try_addr(&self) -> Result<&T>

Get the “address” field of an external pointer. Normally, we will use Deref to do this.

Panics

When the underlying pointer is C NULL.

pub fn try_addr_mut(&mut self) -> Result<&mut T>

Get the “address” field of an external pointer as a mutable reference. Normally, we will use DerefMut to do this.

Panics

When the underlying pointer is C NULL.

Trait Implementations

impl<T: 'static> AsMut<T> for ExternalPtr<T>

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

Converts this type into a mutable reference of the (usually inferred) input type.

impl<T: 'static> AsRef<T> for ExternalPtr<T>

fn as_ref(&self) -> &T

Converts this type into a shared reference of the (usually inferred) input type.

impl<T> Attributes for ExternalPtr<T>

set_attrib

fn get_attrib<'a, N>(&self, name: N) -> Option<Robj>

where Self: 'a, Robj: From<N> + 'a,

Get a specific attribute as a borrowed Robj if it exists.

fn has_attrib<'a, N>(&self, name: N) -> bool

where Self: 'a, Robj: From<N> + 'a,

Return true if an attribute exists.

fn set_attrib<N, V>(&mut self, name: N, value: V) -> Result<&mut Self>

where N: Into<Robj>, V: Into<Robj>,

Set a specific attribute in-place and return the object.

fn names(&self) -> Option<StrIter>

Get the names attribute as a string iterator if one exists.

fn has_names(&self) -> bool

Return true if this object has an attribute called names.

fn set_names<T>(&mut self, names: T) -> Result<&mut Self>

where T: IntoIterator, T::IntoIter: ExactSizeIterator, T::Item: ToVectorValue + AsRef<str>,

Set the names attribute from a string iterator.

fn dim(&self) -> Option<Integers>

Get the dim attribute as an integer iterator if one exists.

fn dimnames(&self) -> Option<ListIter>

Get the dimnames attribute as a list iterator if one exists.

fn class(&self) -> Option<StrIter>

Get the class attribute as a string iterator if one exists.

fn set_class<T>(&mut self, class: T) -> Result<&mut Self>

where T: IntoIterator, T::IntoIter: ExactSizeIterator, T::Item: ToVectorValue + AsRef<str>,

Set the class attribute from a string iterator, and return the same object.

fn inherits(&self, classname: &str) -> bool

Return true if this object has this class attribute. Implicit classes are not supported.

fn levels(&self) -> Option<StrIter>

Get the levels attribute as a string iterator if one exists.

impl<T> Clone for ExternalPtr<T>

Manual implementation of Clone trait, because the assumed constraint T: Clone is not necessary.

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Conversions for ExternalPtr<T>

as_*()

fn as_symbol(&self) -> Option<Symbol>

Convert a symbol object to a Symbol wrapper.

fn as_char(&self) -> Option<Rstr>

Convert a CHARSXP object to a Rstr wrapper.

fn as_raw(&self) -> Option<Raw>

Convert a raw object to a Rstr wrapper.

fn as_language(&self) -> Option<Language>

Convert a language object to a Language wrapper.

fn as_pairlist(&self) -> Option<Pairlist>

Convert a pair list object (LISTSXP) to a Pairlist wrapper.

fn as_list(&self) -> Option<List>

Convert a list object (VECSXP) to a List wrapper.

fn as_expressions(&self) -> Option<Expressions>

Convert an expression object (EXPRSXP) to a Expr wrapper.

fn as_environment(&self) -> Option<Environment>

Convert an environment object (ENVSXP) to a Env wrapper.

fn as_function(&self) -> Option<Function>

Convert a function object (CLOSXP) to a Function wrapper.

fn as_promise(&self) -> Option<Promise>

Get a wrapper for a promise.

impl<T: Debug + 'static> Debug for ExternalPtr<T>

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

Formats the value using the given formatter.

impl<T: 'static> Deref for ExternalPtr<T>

fn deref(&self) -> &Self::Target

This allows us to treat the Robj as if it is the type T.

type Target = T

The resulting type after dereferencing.

impl<T: 'static> DerefMut for ExternalPtr<T>

fn deref_mut(&mut self) -> &mut Self::Target

This allows us to treat the Robj as if it is the mutable type T.

impl<T> From<ExternalPtr<T>> for Robj

fn from(val: ExternalPtr<T>) -> Self

Converts to this type from the input type.

impl<T> GetSexp for ExternalPtr<T>

fn as_robj(&self) -> &Robj

Get a reference to a Robj for this type.

fn as_robj_mut(&mut self) -> &mut Robj

Get a mutable reference to a Robj for this type.

unsafe fn get(&self) -> SEXP

Get a copy of the underlying SEXP.

unsafe fn get_mut(&mut self) -> SEXP

impl<T> Length for ExternalPtr<T>

len() and is_empty()

fn len(&self) -> usize

Get the extended length of the object.

fn is_empty(&self) -> bool

Returns true if the Robj contains no elements.

impl<T> Operators for ExternalPtr<T>

dollar() etc.

fn dollar<T>(&self, symbol: T) -> Result<Robj>

where T: AsRef<str>,

Do the equivalent of x$y

fn slice<T>(&self, rhs: T) -> Result<Robj>

where T: Into<Robj>,

Do the equivalent of x[y]

fn index<T>(&self, rhs: T) -> Result<Robj>

where T: Into<Robj>,

Do the equivalent of x[[y]]

fn tilde<T>(&self, rhs: T) -> Result<Robj>

where T: Into<Robj>,

Do the equivalent of x ~ y

fn double_colon<T>(&self, rhs: T) -> Result<Robj>

where T: Into<Robj>,

Do the equivalent of x :: y

fn call(&self, args: Pairlist) -> Result<Robj>

Do the equivalent of x(a, b, c)

impl<T> PartialEq for ExternalPtr<T>

Manual implementation of PartialEq, because the constraint T: PartialEq is not necessary.

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl<T> Rinternals for ExternalPtr<T>

find_var() etc.

fn is_null(&self) -> bool

Return true if this is the null object.

fn is_symbol(&self) -> bool

Return true if this is a symbol.

fn is_logical(&self) -> bool

Return true if this is a boolean (logical) vector

fn is_real(&self) -> bool

Return true if this is a real (f64) vector.

fn is_complex(&self) -> bool

Return true if this is a complex vector.

fn is_expressions(&self) -> bool

Return true if this is an expression.

fn is_environment(&self) -> bool

Return true if this is an environment.

fn is_promise(&self) -> bool

Return true if this is an environment.

fn is_string(&self) -> bool

Return true if this is a string.

fn is_object(&self) -> bool

Return true if this is an object (ie. has a class attribute).

fn is_s4(&self) -> bool

Return true if this is a S4 object.

fn is_external_pointer(&self) -> bool

Return true if this is an expression.

fn get_current_srcref(val: i32) -> Robj

Get the source ref.

fn get_src_filename(&self) -> Robj

Get the source filename.

fn as_character_vector(&self) -> Robj

Convert to a string vector.

fn coerce_vector(&self, sexptype: SEXPTYPE) -> Robj

Convert to vectors of many kinds.

fn pair_to_vector_list(&self) -> Robj

Convert a pairlist (LISTSXP) to a vector list (VECSXP).

fn vector_to_pair_list(&self) -> Robj

Convert a vector list (VECSXP) to a pair list (LISTSXP)

fn as_character_factor(&self) -> Robj

Convert a factor to a string vector.

fn alloc_matrix(sexptype: SEXPTYPE, rows: i32, cols: i32) -> Robj

Allocate a matrix object.

fn duplicate(&self) -> Robj

Do a deep copy of this object. Note that clone() only adds a reference.

fn find_function<K: TryInto<Symbol, Error = Error>>( &self, key: K, ) -> Result<Robj>

Find a function in an environment ignoring other variables.

fn find_var<K: TryInto<Symbol, Error = Error>>(&self, key: K) -> Result<Robj>

Find a variable in an environment.

fn ncols(&self) -> usize

Number of columns of a matrix

fn nrows(&self) -> usize

Number of rows of a matrix

fn xlengthgets(&self, new_len: usize) -> Result<Robj>

Copy a vector and resize it. See. https://github.com/hadley/r-internals/blob/master/vectors.md

fn alloc_vector(sexptype: SEXPTYPE, len: usize) -> Robj

Allocated an owned object of a certain type.

fn conformable(a: &Robj, b: &Robj) -> bool

Return true if two arrays have identical dims.

fn is_array(&self) -> bool

Return true if this is an array.

fn is_factor(&self) -> bool

Return true if this is factor.

fn is_frame(&self) -> bool

Return true if this is a data frame.

fn is_function(&self) -> bool

Return true if this is a function or a primitive (CLOSXP, BUILTINSXP or SPECIALSXP)

fn is_integer(&self) -> bool

Return true if this is an integer vector (INTSXP) but not a factor.

fn is_language(&self) -> bool

Return true if this is a language object (LANGSXP).

fn is_pairlist(&self) -> bool

Return true if this is NILSXP or LISTSXP.

fn is_matrix(&self) -> bool

Return true if this is a matrix.

fn is_list(&self) -> bool

Return true if this is NILSXP or VECSXP.

fn is_number(&self) -> bool

Return true if this is INTSXP, LGLSXP or REALSXP but not a factor.

fn is_primitive(&self) -> bool

Return true if this is a primitive function BUILTINSXP, SPECIALSXP.

fn is_ts(&self) -> bool

Return true if this is a time series vector (see tsp).

fn is_user_binop(&self) -> bool

Return true if this is a user defined binop.

fn is_vector(&self) -> bool

Return true if this is a vector.

fn is_vector_atomic(&self) -> bool

Return true if this is an atomic vector.

fn is_vector_list(&self) -> bool

Return true if this is a vector list.

fn is_vectorizable(&self) -> bool

Return true if this is can be made into a vector.

fn is_raw(&self) -> bool

Return true if this is RAWSXP.

fn is_char(&self) -> bool

Return true if this is CHARSXP.

fn is_missing_arg(&self) -> bool

fn is_unbound_value(&self) -> bool

fn is_package_env(&self) -> bool

fn package_env_name(&self) -> Robj

fn is_namespace_env(&self) -> bool

fn namespace_env_spec(&self) -> Robj

fn is_altrep(&self) -> bool

Returns true if this is an ALTREP object.

fn is_altinteger(&self) -> bool

Returns true if this is an integer ALTREP object.

fn is_altreal(&self) -> bool

Returns true if this is an real ALTREP object.

fn is_altlogical(&self) -> bool

Returns true if this is an logical ALTREP object.

fn is_altraw(&self) -> bool

Returns true if this is a raw ALTREP object.

fn is_altstring(&self) -> bool

Returns true if this is an integer ALTREP object.

fn is_altlist(&self) -> bool

Returns true if this is an integer ALTREP object.

fn deparse(&self) -> Result<String>

Generate a text representation of this object.

impl<T> Slices for ExternalPtr<T>

as_typed_slice_raw() etc.

unsafe fn as_typed_slice_raw<T>(&self) -> &[T]

Get an immutable slice to this object’s data.

unsafe fn as_typed_slice_raw_mut<T>(&mut self) -> &mut [T]

Get a mutable slice to this object’s data.

impl<T: 'static> TryFrom<&Robj> for &ExternalPtr<T>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: &Robj) -> Result<Self>

Performs the conversion.

impl<T: 'static> TryFrom<&Robj> for ExternalPtr<T>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(robj: &Robj) -> Result<Self>

Performs the conversion.

impl<T: 'static> TryFrom<&mut Robj> for &mut ExternalPtr<T>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: &mut Robj) -> Result<Self>

Performs the conversion.

impl<T: 'static> TryFrom<Robj> for &ExternalPtr<T>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Robj) -> Result<Self>

Performs the conversion.

impl<T: 'static> TryFrom<Robj> for &mut ExternalPtr<T>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Robj) -> Result<Self>

Performs the conversion.

impl<T: 'static> TryFrom<Robj> for ExternalPtr<T>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(robj: Robj) -> Result<Self>

Performs the conversion.

impl<T> Types for ExternalPtr<T>

rtype() and rany()

fn rtype(&self) -> Rtype

Get the type of an R object.

fn as_any(&self) -> Rany<'_>