Trait IntoR

Source

pub trait IntoR {
    type Error: Display;

    // Required method
    fn try_into_sexp(self) -> Result<SEXP, Self::Error>;

    // Provided methods
    unsafe fn try_into_sexp_unchecked(self) -> Result<SEXP, Self::Error>
       where Self: Sized { ... }
    fn into_sexp(self) -> SEXP
       where Self: Sized { ... }
    unsafe fn into_sexp_unchecked(self) -> SEXP
       where Self: Sized { ... }
}

Expand description

Trait for converting Rust types to R SEXP values.

Outbound counterpart of crate::from_r::TryFromSexp. This is the lax path for 64-bit integer types — values that overflow i32 silently land as REALSXP. For the strict alternative, see crate::strict and the #[miniextendr(strict)] attribute.

§Required Method

Implementors must provide try_into_sexp and specify Error. The other three methods have sensible defaults.

§Examples

use miniextendr_api::into_r::IntoR;

let sexp = 42i32.into_sexp();
let sexp = "hello".to_string().into_sexp();

// Fallible path:
let result = "hello".try_into_sexp();
assert!(result.is_ok());

Required Associated Types§

Source

type Error: Display

The error type for fallible conversions.

Use std::convert::Infallible for types that can never fail. Use IntoRError for types that may fail (e.g. strings exceeding R’s i32 length limit).

Required Methods§

Source

fn try_into_sexp(self) -> Result<SEXP, Self::Error>

Try to convert this value to an R SEXP.

This is the required method. All other methods delegate to it.

Provided Methods§

Source

unsafe fn try_into_sexp_unchecked(self) -> Result<SEXP, Self::Error>
where Self: Sized,

Try to convert to SEXP without thread safety checks.

§Safety

Must be called from R’s main thread.

Source

fn into_sexp(self) -> SEXP
where Self: Sized,

Convert this value to an R SEXP, panicking on error.

In debug builds, asserts that we’re on R’s main thread.

Source

unsafe fn into_sexp_unchecked(self) -> SEXP
where Self: Sized,

Convert to SEXP without thread safety checks, panicking on error.

§Safety

Must be called from R’s main thread. In debug builds, this still calls the checked version by default, but implementations may skip thread assertions for performance.

Dyn Compatibility§

This trait is dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Mode	On `Err(e)`	Bound Required
Default	R error via panic	`E: Debug`
`unwrap_in_r`	`list(error = ...)`	`E: Display`

Trait IntoR Copy item path

§Required Method

§Examples

Required Associated Types§

type Error: Display

Required Methods§

fn try_into_sexp(self) -> Result<SEXP, Self::Error>

Provided Methods§

unsafe fn try_into_sexp_unchecked(self) -> Result<SEXP, Self::Error>where Self: Sized,

§Safety

fn into_sexp(self) -> SEXPwhere Self: Sized,

unsafe fn into_sexp_unchecked(self) -> SEXPwhere Self: Sized,

§Safety

Dyn Compatibility§

Implementations on Foreign Types§

impl IntoR for &OsStr

type Error = IntoRError

fn try_into_sexp(self) -> Result<SEXP, Self::Error>

unsafe fn try_into_sexp_unchecked(self) -> Result<SEXP, Self::Error>

fn into_sexp(self) -> SEXP

unsafe fn into_sexp_unchecked(self) -> SEXP

impl IntoR for &Path

type Error = IntoRError

fn try_into_sexp(self) -> Result<SEXP, Self::Error>

unsafe fn try_into_sexp_unchecked(self) -> Result<SEXP, Self::Error>

fn into_sexp(self) -> SEXP

unsafe fn into_sexp_unchecked(self) -> SEXP

impl IntoR for &[&str]

type Error = !

fn try_into_sexp(self) -> Result<SEXP, Self::Error>

unsafe fn try_into_sexp_unchecked(self) -> Result<SEXP, Self::Error>

fn into_sexp(self) -> SEXP

unsafe fn into_sexp_unchecked(self) -> SEXP

impl IntoR for &[Rboolean]

type Error = !

fn try_into_sexp(self) -> Result<SEXP, Self::Error>

unsafe fn try_into_sexp_unchecked(self) -> Result<SEXP, Self::Error>

fn into_sexp(self) -> SEXP

unsafe fn into_sexp_unchecked(self) -> SEXP

impl IntoR for &[String]

type Error = !

fn try_into_sexp(self) -> Result<SEXP, Self::Error>

unsafe fn try_into_sexp_unchecked(self) -> Result<SEXP, Self::Error>

fn into_sexp(self) -> SEXP

unsafe fn into_sexp_unchecked(self) -> SEXP

impl IntoR for &[bool]

type Error = !

fn try_into_sexp(self) -> Result<SEXP, Self::Error>

unsafe fn try_into_sexp_unchecked(self) -> Result<SEXP, Self::Error>

fn into_sexp(self) -> SEXP

unsafe fn into_sexp_unchecked(self) -> SEXP

impl IntoR for &[f32]

type Error = !

fn try_into_sexp(self) -> Result<SEXP, Self::Error>

unsafe fn try_into_sexp_unchecked(self) -> Result<SEXP, Self::Error>

fn into_sexp(self) -> SEXP

unsafe fn into_sexp_unchecked(self) -> SEXP

impl IntoR for &[i8]

type Error = !

fn try_into_sexp(self) -> Result<SEXP, Self::Error>

unsafe fn try_into_sexp_unchecked(self) -> Result<SEXP, Self::Error>

fn into_sexp(self) -> SEXP

unsafe fn into_sexp_unchecked(self) -> SEXP

impl IntoR for &[i16]

type Error = !

fn try_into_sexp(self) -> Result<SEXP, Self::Error>

unsafe fn try_into_sexp_unchecked(self) -> Result<SEXP, Self::Error>

fn into_sexp(self) -> SEXP

unsafe fn into_sexp_unchecked(self) -> SEXP

impl IntoR for &[i64]

type Error = !

fn try_into_sexp(self) -> Result<SEXP, Self::Error>

unsafe fn try_into_sexp_unchecked(self) -> Result<SEXP, Self::Error>

fn into_sexp(self) -> SEXP

unsafe fn into_sexp_unchecked(self) -> SEXP

impl IntoR for &[isize]

type Error = !

fn try_into_sexp(self) -> Result<SEXP, Self::Error>

unsafe fn try_into_sexp_unchecked(self) -> Result<SEXP, Self::Error>

fn into_sexp(self) -> SEXP

Trait IntoR

unsafe fn try_into_sexp_unchecked(self) -> Result<SEXP, Self::Error>
where Self: Sized,

fn into_sexp(self) -> SEXP
where Self: Sized,

unsafe fn into_sexp_unchecked(self) -> SEXP
where Self: Sized,