Struct RLogical 

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

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

impl RLogical

pub const FALSE: Self

FALSE logical scalar.

pub const TRUE: Self

TRUE logical scalar.

pub const NA: Self

Missing logical scalar (NA_LOGICAL).

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

Construct directly from raw R logical storage.

pub const fn to_i32(self) -> i32

Get raw R logical storage value.

pub const fn is_na(self) -> bool

Returns whether the value is NA_LOGICAL.

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

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

Trait Implementations

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

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

Get a pointer to the underlying data, possibly triggering materialization.

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

Get a read-only pointer without forcing materialization.

impl AltrepDataptr<RLogical> for Vec<bool>

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

Get a pointer to the underlying data, possibly triggering materialization.

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

Get a read-only pointer without forcing materialization.

impl Clone for RLogical

fn clone(&self) -> RLogical

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RLogical

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

Formats the value using the given formatter.

impl Eq for RLogical

#[doc(hidden)]

fn assert_fields_are_eq(&self)

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

#[doc(hidden)]

fn assert_receiver_is_total_eq(&self)

👎Deprecated since 1.95.0:

implementation detail of #[derive(Eq)]

impl From<Logical> for RLogical

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

fn from(l: Logical) -> Self

Converts to this type from the input type.

impl From<RLogical> for Logical

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

fn from(r: RLogical) -> Self

Converts to this type from the input type.

impl From<bool> for RLogical

fn from(value: bool) -> Self

Converts to this type from the input type.

impl Hash for RLogical

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl IntoR for RLogical

type Error = Infallible

The error type for fallible conversions.

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

Try to convert this value to an R SEXP.

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

Try to convert to SEXP without thread safety checks.

fn into_sexp(self) -> SEXP

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

unsafe fn into_sexp_unchecked(self) -> SEXP

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

impl IntoRAs<RLogical> for &[bool]

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

Convert to R SEXP with the specified target storage type.

impl IntoRAs<RLogical> for RLogical

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

Convert to R SEXP with the specified target storage type.

impl IntoRAs<RLogical> for Vec<bool>

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

Convert to R SEXP with the specified target storage type.

impl IntoRAs<RLogical> for bool

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

Convert to R SEXP with the specified target storage type.

impl IntoRAs<RLogical> for i32

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

Convert to R SEXP with the specified target storage type.

impl IntoRAs<String> for RLogical

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

Convert to R SEXP with the specified target storage type.

impl PartialEq for RLogical

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl RNativeType for RLogical

const SEXP_TYPE: SEXPTYPE = SEXPTYPE::LGLSXP

The SEXPTYPE for vectors containing this element type.

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

Get mutable pointer to vector data.

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

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

impl TryCoerce<bool> for RLogical

type Error = LogicalCoerceError

Error returned when coercion fails.

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

Attempt to convert self into R.

impl TryFromSexp for &'static RLogical

type Error = SexpError

The error type returned when conversion fails.

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

Attempt to convert an R SEXP to this Rust type.

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

Convert from SEXP without thread safety checks.

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.

type Error = SexpError

The error type returned when conversion fails.

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

Attempt to convert an R SEXP to this Rust type.

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

Convert from SEXP without thread safety checks.

impl TryFromSexp for RLogical

type Error = SexpError

The error type returned when conversion fails.

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

Attempt to convert an R SEXP to this Rust type.

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

Convert from SEXP without thread safety checks.

impl Copy for RLogical

impl StructuralPartialEq for RLogical

impl TrivialClone for RLogical

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: 4 bytes