Skip to main content

RLogical

Struct RLogical 

Source
#[repr(transparent)]
pub struct RLogical(i32);
Expand description

R’s logical element type (the contents of a LGLSXP vector).

In R, logical vectors are stored as int with possible values:

  • 0 for FALSE
  • 1 for TRUE
  • NA_LOGICAL (typically INT_MIN) for NA

Important: R may also contain other non-zero values in logical vectors (e.g., from low-level code). Those should be interpreted as TRUE.

This type is repr(transparent) over i32 so any raw value is valid, avoiding UB when viewing LGLSXP data as a slice.

Tuple Fields§

§0: i32

Implementations§

Source§

impl RLogical

Source

pub const FALSE: Self

FALSE logical scalar.

Source

pub const TRUE: Self

TRUE logical scalar.

Source

pub const NA: Self

Missing logical scalar (NA_LOGICAL).

Source

pub const fn from_i32(raw: i32) -> Self

Construct directly from raw R logical storage.

Source

pub const fn to_i32(self) -> i32

Get raw R logical storage value.

Source

pub const fn is_na(self) -> bool

Returns whether the value is NA_LOGICAL.

Source

pub const fn to_option_bool(self) -> Option<bool>

Convert to Rust Option<bool> (None for NA).

Trait Implementations§

Source§

impl AltrepDataptr<RLogical> for Box<[bool]>

Source§

fn dataptr(&mut self, _writable: bool) -> Option<*mut RLogical>

Get a pointer to the underlying data, possibly triggering materialization. Read more
Source§

fn dataptr_or_null(&self) -> Option<*const T>

Get a read-only pointer without forcing materialization. Read more
Source§

impl AltrepDataptr<RLogical> for Vec<bool>

Source§

fn dataptr(&mut self, _writable: bool) -> Option<*mut RLogical>

Get a pointer to the underlying data, possibly triggering materialization. Read more
Source§

fn dataptr_or_null(&self) -> Option<*const T>

Get a read-only pointer without forcing materialization. Read more
Source§

impl Clone for RLogical

Source§

fn clone(&self) -> RLogical

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 RLogical

Source§

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

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

impl From<Logical> for RLogical

Convert from Logical (semantic type) to RLogical (FFI type).

Source§

fn from(l: Logical) -> Self

Converts to this type from the input type.
Source§

impl From<RLogical> for Logical

Convert from RLogical (FFI type) to Logical (semantic type).

Source§

fn from(r: RLogical) -> Self

Converts to this type from the input type.
Source§

impl From<bool> for RLogical

Source§

fn from(value: bool) -> Self

Converts to this type from the input type.
Source§

impl Hash for RLogical

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 IntoR for RLogical

Source§

type Error = Infallible

The error type for fallible conversions. Read more
Source§

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

Try to convert this value to an R SEXP. Read more
Source§

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

Try to convert to SEXP without thread safety checks. Read more
Source§

fn into_sexp(self) -> SEXP

Convert this value to an R SEXP, panicking on error. Read more
Source§

unsafe fn into_sexp_unchecked(self) -> SEXP

Convert to SEXP without thread safety checks, panicking on error. Read more
Source§

impl IntoRAs<RLogical> for &[bool]

Source§

fn into_r_as(self) -> Result<SEXP, StorageCoerceError>

Convert to R SEXP with the specified target storage type.
Source§

impl IntoRAs<RLogical> for RLogical

Source§

fn into_r_as(self) -> Result<SEXP, StorageCoerceError>

Convert to R SEXP with the specified target storage type.
Source§

impl IntoRAs<RLogical> for Vec<bool>

Source§

fn into_r_as(self) -> Result<SEXP, StorageCoerceError>

Convert to R SEXP with the specified target storage type.
Source§

impl IntoRAs<RLogical> for bool

Source§

fn into_r_as(self) -> Result<SEXP, StorageCoerceError>

Convert to R SEXP with the specified target storage type.
Source§

impl IntoRAs<RLogical> for i32

Source§

fn into_r_as(self) -> Result<SEXP, StorageCoerceError>

Convert to R SEXP with the specified target storage type.
Source§

impl IntoRAs<String> for RLogical

Source§

fn into_r_as(self) -> Result<SEXP, StorageCoerceError>

Convert to R SEXP with the specified target storage type.
Source§

impl PartialEq for RLogical

Source§

fn eq(&self, other: &RLogical) -> 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 RNativeType for RLogical

Source§

const SEXP_TYPE: SEXPTYPE = SEXPTYPE::LGLSXP

The SEXPTYPE for vectors containing this element type.
Source§

unsafe fn dataptr_mut(sexp: SEXP) -> *mut Self

Get mutable pointer to vector data. Read more
Source§

fn elt(sexp: SEXP, i: isize) -> Self

Read the i-th element via the appropriate *_ELT accessor. Read more
Source§

impl TryCoerce<bool> for RLogical

Source§

type Error = LogicalCoerceError

Error returned when coercion fails.
Source§

fn try_coerce(self) -> Result<bool, LogicalCoerceError>

Attempt to convert self into R.
Source§

impl TryFromSexp for &'static RLogical

Source§

type Error = SexpError

The error type returned when conversion fails.
Source§

fn try_from_sexp(sexp: SEXP) -> Result<Self, Self::Error>

Attempt to convert an R SEXP to this Rust type. Read more
Source§

unsafe fn try_from_sexp_unchecked(sexp: SEXP) -> Result<Self, Self::Error>

Convert from SEXP without thread safety checks. Read more
Source§

impl TryFromSexp for &'static mut RLogical

§Safety note (aliasing)

This impl can produce aliased &mut references if the same R object is passed to multiple mutable parameters. The caller (generated wrapper) is responsible for ensuring no two &mut borrows alias the same SEXP.

Source§

type Error = SexpError

The error type returned when conversion fails.
Source§

fn try_from_sexp(sexp: SEXP) -> Result<Self, Self::Error>

Attempt to convert an R SEXP to this Rust type. Read more
Source§

unsafe fn try_from_sexp_unchecked(sexp: SEXP) -> Result<Self, Self::Error>

Convert from SEXP without thread safety checks. Read more
Source§

impl TryFromSexp for RLogical

Source§

type Error = SexpError

The error type returned when conversion fails.
Source§

fn try_from_sexp(sexp: SEXP) -> Result<Self, Self::Error>

Attempt to convert an R SEXP to this Rust type. Read more
Source§

unsafe fn try_from_sexp_unchecked(sexp: SEXP) -> Result<Self, Self::Error>

Convert from SEXP without thread safety checks. Read more
Source§

impl Copy for RLogical

Source§

impl Eq for RLogical

Source§

impl StructuralPartialEq for RLogical

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> AsRNativeExt for T
where T: RNativeType,

Source§

fn wrap_r_native(self) -> AsRNative<Self>

Wrap self in AsRNative for native R scalar conversion.
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> 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.