Struct extendr_api::wrapper::externalptr::ExternalPtr

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

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§

source§

impl<T> ExternalPtr<T>

source

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.

source

pub fn tag(&self) -> Robj

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

source

pub fn protected(&self) -> Robj

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

source

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.

source

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.

source

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.

source

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§

source§

impl<T> AsMut<T> for ExternalPtr<T>

source§

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

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

impl<T> AsRef<T> for ExternalPtr<T>

source§

fn as_ref(&self) -> &T

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

impl<T> Attributes for ExternalPtr<T>

set_attrib

source§

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. Read more
source§

fn has_attrib<'a, N>(&self, name: N) -> bool
where Self: 'a, Robj: From<N> + 'a,

Return true if an attribute exists.
source§

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. Read more
source§

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

Get the names attribute as a string iterator if one exists. Read more
source§

fn has_names(&self) -> bool

Return true if this object has an attribute called names.
source§

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

Set the names attribute from a string iterator. Read more
source§

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

Get the dim attribute as an integer iterator if one exists. Read more
source§

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

Get the dimnames attribute as a list iterator if one exists. Read more
source§

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

Get the class attribute as a string iterator if one exists. Read more
source§

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

Set the class attribute from a string iterator, and return the same object. Read more
source§

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

Return true if this object has this class attribute. Implicit classes are not supported. Read more
source§

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

Get the levels attribute as a string iterator if one exists. Read more
source§

impl<T> Clone for ExternalPtr<T>

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

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<T> Conversions for ExternalPtr<T>

as_*()

source§

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

Convert a symbol object to a Symbol wrapper. Read more
source§

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

Convert a CHARSXP object to a Rstr wrapper. Read more
source§

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

Convert a raw object to a Rstr wrapper. Read more
source§

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

Convert a language object to a Language wrapper. Read more
source§

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

Convert a pair list object (LISTSXP) to a Pairlist wrapper. Read more
source§

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

Convert a list object (VECSXP) to a List wrapper. Read more
source§

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

Convert an expression object (EXPRSXP) to a Expr wrapper. Read more
source§

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

Convert an environment object (ENVSXP) to a Env wrapper. Read more
source§

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

Convert a function object (CLOSXP) to a Function wrapper. Read more
source§

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

Get a wrapper for a promise.
source§

impl<T: Debug> Debug for ExternalPtr<T>

source§

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

Formats the value using the given formatter. Read more
source§

impl<T> Deref for ExternalPtr<T>

source§

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.
source§

impl<T> DerefMut for ExternalPtr<T>

source§

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

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

source§

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

source§

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

Converts to this type from the input type.
source§

impl<T> GetSexp for ExternalPtr<T>

source§

fn as_robj(&self) -> &Robj

Get a reference to a Robj for this type.

source§

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

Get a mutable reference to a Robj for this type.

source§

unsafe fn get(&self) -> SEXP

Get a copy of the underlying SEXP. Read more
source§

unsafe fn get_mut(&mut self) -> SEXP

source§

impl<T> Length for ExternalPtr<T>

len() and is_empty()

source§

fn len(&self) -> usize

Get the extended length of the object. Read more
source§

fn is_empty(&self) -> bool

Returns true if the Robj contains no elements. Read more
source§

impl<T> Operators for ExternalPtr<T>

dollar() etc.

source§

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

Do the equivalent of x$y Read more
source§

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

Do the equivalent of x[y] Read more
source§

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

Do the equivalent of x[[y]] Read more
source§

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

Do the equivalent of x ~ y Read more
source§

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

Do the equivalent of x :: y Read more
source§

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

Do the equivalent of x(a, b, c) Read more
source§

impl<T> PartialEq for ExternalPtr<T>

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

source§

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

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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.
source§

impl<T> Rinternals for ExternalPtr<T>

find_var() etc.

source§

fn is_null(&self) -> bool

Return true if this is the null object.
source§

fn is_symbol(&self) -> bool

Return true if this is a symbol.
source§

fn is_logical(&self) -> bool

Return true if this is a boolean (logical) vector
source§

fn is_real(&self) -> bool

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

fn is_complex(&self) -> bool

Return true if this is a complex vector.
source§

fn is_expressions(&self) -> bool

Return true if this is an expression.
source§

fn is_environment(&self) -> bool

Return true if this is an environment.
source§

fn is_promise(&self) -> bool

Return true if this is an environment.
source§

fn is_string(&self) -> bool

Return true if this is a string.
source§

fn is_object(&self) -> bool

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

fn is_s4(&self) -> bool

Return true if this is a S4 object.
source§

fn is_external_pointer(&self) -> bool

Return true if this is an expression.
source§

fn get_current_srcref(val: i32) -> Robj

Get the source ref.
source§

fn get_src_filename(&self) -> Robj

Get the source filename.
source§

fn as_character_vector(&self) -> Robj

Convert to a string vector.
source§

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

Convert to vectors of many kinds.
source§

fn pair_to_vector_list(&self) -> Robj

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

fn vector_to_pair_list(&self) -> Robj

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

fn as_character_factor(&self) -> Robj

Convert a factor to a string vector.
source§

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

Allocate a matrix object.
source§

fn duplicate(&self) -> Robj

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

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

Find a function in an environment ignoring other variables. Read more
source§

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

Find a variable in an environment. Read more
source§

fn eval_promise(&self) -> Result<Robj>

If this object is a promise, evaluate it, otherwise return the object. Read more
source§

fn ncols(&self) -> usize

Number of columns of a matrix
source§

fn nrows(&self) -> usize

Number of rows of a matrix
source§

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

source§

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

Allocated an owned object of a certain type.
source§

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

Return true if two arrays have identical dims.
source§

fn is_array(&self) -> bool

Return true if this is an array.
source§

fn is_factor(&self) -> bool

Return true if this is factor.
source§

fn is_frame(&self) -> bool

Return true if this is a data frame.
source§

fn is_function(&self) -> bool

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

fn is_integer(&self) -> bool

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

fn is_language(&self) -> bool

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

fn is_pairlist(&self) -> bool

Return true if this is NILSXP or LISTSXP.
source§

fn is_matrix(&self) -> bool

Return true if this is a matrix.
source§

fn is_list(&self) -> bool

Return true if this is NILSXP or VECSXP.
source§

fn is_number(&self) -> bool

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

fn is_primitive(&self) -> bool

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

fn is_ts(&self) -> bool

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

fn is_user_binop(&self) -> bool

Return true if this is a user defined binop.
source§

fn is_valid_string(&self) -> bool

Return true if this is a valid string.
source§

fn is_valid_string_f(&self) -> bool

Return true if this is a valid string.
source§

fn is_vector(&self) -> bool

Return true if this is a vector.
source§

fn is_vector_atomic(&self) -> bool

Return true if this is an atomic vector.
source§

fn is_vector_list(&self) -> bool

Return true if this is a vector list.
source§

fn is_vectorizable(&self) -> bool

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

fn is_raw(&self) -> bool

Return true if this is RAWSXP.
source§

fn is_char(&self) -> bool

Return true if this is CHARSXP.
source§

fn is_missing_arg(&self) -> bool

source§

fn is_unbound_value(&self) -> bool

source§

fn is_package_env(&self) -> bool

source§

fn package_env_name(&self) -> Robj

source§

fn is_namespace_env(&self) -> bool

source§

fn namespace_env_spec(&self) -> Robj

source§

fn is_altrep(&self) -> bool

Returns true if this is an ALTREP object.
source§

fn is_altinteger(&self) -> bool

Returns true if this is an integer ALTREP object.
source§

fn is_altreal(&self) -> bool

Returns true if this is an real ALTREP object.
source§

fn is_altlogical(&self) -> bool

Returns true if this is an logical ALTREP object.
source§

fn is_altraw(&self) -> bool

Returns true if this is a raw ALTREP object.
source§

fn is_altstring(&self) -> bool

Returns true if this is an integer ALTREP object.
source§

fn is_altlist(&self) -> bool

Returns true if this is an integer ALTREP object.
source§

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

Generate a text representation of this object.
source§

impl<T> Slices for ExternalPtr<T>

as_typed_slice_raw() etc.

source§

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

Get an immutable slice to this object’s data. Read more
source§

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

Get a mutable slice to this object’s data. Read more
source§

impl<T> TryFrom<&Robj> for &ExternalPtr<T>

§

type Error = Error

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

impl<T> TryFrom<&Robj> for ExternalPtr<T>

§

type Error = Error

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

impl<T> TryFrom<&mut Robj> for &mut ExternalPtr<T>

§

type Error = Error

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

impl<T> TryFrom<Robj> for ExternalPtr<T>

§

type Error = Error

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

impl<T> Types for ExternalPtr<T>

rtype() and rany()

source§

fn rtype(&self) -> Rtype

Get the type of an R object. Read more
source§

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

Auto Trait Implementations§

§

impl<T> Freeze for ExternalPtr<T>

§

impl<T> RefUnwindSafe for ExternalPtr<T>
where T: RefUnwindSafe,

§

impl<T> !Send for ExternalPtr<T>

§

impl<T> !Sync for ExternalPtr<T>

§

impl<T> Unpin for ExternalPtr<T>
where T: Unpin,

§

impl<T> UnwindSafe for ExternalPtr<T>
where T: UnwindSafe,

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
§

impl<'short, T, Target> AsGeneralizedMut<'short, &'short mut Target> for T
where T: AsMut<Target> + ?Sized, Target: ?Sized,

§

impl<'short, T, Target> AsGeneralizedRef<'short, &'short Target> for T
where T: AsRef<Target> + ?Sized, Target: ?Sized,

source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

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

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> IntoEither for T

source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

impl<T> IntoRobj for T
where Robj: From<T>,

§

impl<T> Pointable for T

§

const ALIGN: usize = _

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
source§

impl<R> Save for R
where R: GetSexp,

source§

fn save<P: AsRef<Path>>( &self, path: &P, format: PstreamFormat, version: i32, hook: Option<WriteHook>, ) -> Result<()>

Save an object in the R data format. version should probably be 3.
source§

fn to_writer<W: Write>( &self, writer: &mut W, format: PstreamFormat, version: i32, hook: Option<WriteHook>, ) -> Result<()>

Save an object in the R data format to a Write trait. version should probably be 3.
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, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

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

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

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

Performs the conversion.