Skip to main content

RSidecar

Struct RSidecar 

Source
pub struct RSidecar;
Expand description

Marker type for enabling R sidecar accessors in an ExternalPtr struct.

When used with #[derive(ExternalPtr)] and #[r_data], this field acts as a selector that enables R-facing accessors for sibling #[r_data] fields.

§Supported Field Types

  • SEXP - Raw SEXP access, no conversion
  • i32, f64, bool, u8 - Zero-overhead scalars (stored directly in R)
  • Any IntoR type - Automatic conversion (e.g., String, Vec<T>)

§Example

use miniextendr_api::ffi::SEXP;

#[derive(ExternalPtr)]
pub struct MyType {
    pub x: i32,

    /// Selector field - enables R wrapper generation
    #[r_data]
    r: RSidecar,

    /// Raw SEXP slot - MyType_get_raw() / MyType_set_raw()
    #[r_data]
    pub raw: SEXP,

    /// Zero-overhead scalar - MyType_get_count() / MyType_set_count()
    #[r_data]
    pub count: i32,

    /// Conversion type - MyType_get_name() / MyType_set_name()
    #[r_data]
    pub name: String,
}

§Design Notes

  • RSidecar is a ZST (zero-sized type) - no runtime cost
  • Only pub #[r_data] fields get R wrapper functions generated
  • Multiple RSidecar fields in one struct is a compile error

Trait Implementations§

Source§

impl Clone for RSidecar

Source§

fn clone(&self) -> RSidecar

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 RSidecar

Source§

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

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

impl Default for RSidecar

Source§

fn default() -> RSidecar

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

impl Hash for RSidecar

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for RSidecar

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl Copy for RSidecar

Source§

impl Eq for RSidecar

Source§

impl StructuralPartialEq for RSidecar

Auto Trait Implementations§

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,

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> RClone for T
where T: Clone,

Source§

fn clone(&self) -> T

Create a deep copy of this value.
Source§

impl<T> RCopy for T
where T: Copy,

Source§

fn copy(&self) -> T

Create a bitwise copy of this value. Read more
Source§

fn is_copy(&self) -> bool

Check if this type implements Copy. Read more
Source§

impl<T> RDebug for T
where T: Debug,

Source§

fn debug_str(&self) -> String

Get a compact debug string representation.
Source§

fn debug_str_pretty(&self) -> String

Get a pretty-printed debug string with indentation.
Source§

impl<T> RDefault for T
where T: Default,

Source§

fn default() -> T

Create a new instance with default values.
Source§

impl<T> RHash for T
where T: Hash,

Source§

fn hash(&self) -> i64

Compute a hash of this value.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

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>,

Source§

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>,

Source§

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.