Skip to main content

RSymbol

miniextendr_api::expression

Struct RSymbol

pub struct RSymbol {
    sexp: SEXP,
}

Expand description

A safe wrapper around R symbols (SYMSXP).

R symbols are interned strings used as variable and function names. They are never garbage collected, so RSymbol does not need GC protection.

§Example

let sym = RSymbol::new("paste0");
// sym.as_sexp() is a SYMSXP that can be used in call construction

Fields§

§sexp: SEXP

Implementations§

impl RSymbol

pub unsafe fn new(name: &str) -> Self

Create or retrieve an interned R symbol.

§Safety

Must be called from the R main thread.

§Panics

Panics if name contains a null byte.

pub unsafe fn from_cstr(name: &CStr) -> Self

Create a symbol from a C string literal.

This avoids the allocation needed by new when you have a &CStr available (e.g., from c"name" literals).

§Safety

Must be called from the R main thread.

pub fn as_sexp(&self) -> SEXP

Get the underlying SEXP.

Auto Trait Implementations§

impl Freeze for RSymbol

impl RefUnwindSafe for RSymbol

impl Send for RSymbol

impl Sync for RSymbol

impl Unpin for RSymbol

impl UnsafeUnpin for RSymbol

impl UnwindSafe for RSymbol

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

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

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> SizeEq<Cell<T>> for T
where T: ?Sized,

type CastFrom = CastFromWrapper

impl<T> SizeEq<ManuallyDrop<T>> for T
where T: ?Sized,

type CastFrom = CastFromWrapper

impl<T> SizeEq<MaybeUninit<T>> for T

type CastFrom = CastSizedExact

impl<T> SizeEq<ReadOnly<T>> for T
where T: ?Sized,

type CastFrom = CastFromReadOnly

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

type CastFrom = IdCast

impl<T> SizeEq<Unalign<T>> for T

type CastFrom = CastFromWrapper

impl<T> SizeEq<UnsafeCell<T>> for T
where T: ?Sized,

type CastFrom = CastFromWrapper

impl<T> SizeEq<Wrapping<T>> for T

type CastFrom = CastFromWrapper

impl<T> SizedTypeProperties for T

#[doc(hidden)]
const SIZE: usize = _

🔬This is a nightly-only experimental API. (sized_type_properties)

#[doc(hidden)]
const ALIGN: usize = _

🔬This is a nightly-only experimental API. (sized_type_properties)

#[doc(hidden)]
const ALIGNMENT: Alignment = _

🔬This is a nightly-only experimental API. (ptr_alignment_type)

#[doc(hidden)]
const IS_ZST: bool = _

🔬This is a nightly-only experimental API. (sized_type_properties)

true if this type requires no storage. false if its size is greater than zero. Read more

#[doc(hidden)]
const LAYOUT: Layout = _

🔬This is a nightly-only experimental API. (sized_type_properties)

#[doc(hidden)]
const MAX_SLICE_LEN: usize = _

🔬This is a nightly-only experimental API. (sized_type_properties)

The largest safe length for a [Self]. Read more

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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.

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

Performs the conversion.

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

impl<T> InvariantsEq<ManuallyDrop<T>> for T
where T: ?Sized,

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

impl<T> InvariantsEq<Unalign<T>> for T

impl<T> InvariantsEq<Wrapping<T>> for T

impl<Src, Dst, A, SV, DV, R> MutationCompatible<Src, A, SV, DV, (BecauseRead, R)> for Dst
where A: Aliasing, SV: Validity, DV: Validity, Src: Read<A, R> + ?Sized, Dst: Read<A, R> + ?Sized,

impl<Src, Dst, A, SV, DV> MutationCompatible<Src, A, SV, DV, BecauseInvariantsEq> for Dst
where A: Aliasing, SV: Validity, DV: Validity, Src: TransmuteFrom<Dst, DV, SV> + ?Sized, Dst: TransmuteFrom<Src, SV, DV> + InvariantsEq<Src> + ?Sized,

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

impl<T> TransmuteFrom<Cell<T>, Valid, Valid> for T
where T: ?Sized,

impl<T> TransmuteFrom<ManuallyDrop<T>, Valid, Valid> for T
where T: ?Sized,

impl<T> TransmuteFrom<ReadOnly<T>, Valid, Valid> for T
where T: ?Sized,

impl<Src, Dst> TransmuteFrom<Src, Initialized, Initialized> for Dst
where Src: ?Sized, Dst: ?Sized,

impl<Src, Dst, V> TransmuteFrom<Src, V, Uninit> for Dst
where V: Validity, Src: ?Sized, Dst: ?Sized,

impl<Src, Dst> TransmuteFrom<Src, Valid, Initialized> for Dst
where Src: IntoBytes + ?Sized, Dst: ?Sized,

impl<T> TransmuteFrom<Unalign<T>, Valid, Valid> for T

impl<T> TransmuteFrom<UnsafeCell<T>, Valid, Valid> for T
where T: ?Sized,

impl<T> TransmuteFrom<Wrapping<T>, Valid, Valid> for T

impl<Src, Dst, A, SV, DV, C, R> TransmuteFromPtr<Src, A, SV, DV, C, R> for Dst
where A: Aliasing, SV: Validity, DV: Validity, C: CastExact<Src, Dst>, Dst: TransmuteFrom<Src, SV, DV> + TryTransmuteFromPtr<Src, A, SV, DV, C, R> + ?Sized, Src: ?Sized,

impl<Src, Dst, SV, DV, A, C, R> TryTransmuteFromPtr<Src, A, SV, DV, C, (BecauseMutationCompatible, R)> for Dst
where A: Aliasing, SV: Validity, DV: Validity, Src: TransmuteFrom<Dst, DV, SV> + ?Sized, Dst: MutationCompatible<Src, A, SV, DV, R> + ?Sized, C: CastExact<Src, Dst>,

Layout§

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 8 bytes