Struct Rbool

pub struct Rbool(/* private fields */);

Rbool is a wrapper for i32 in the context of an R’s logical vector.

Rbool can have a value of 0, 1 or i32::MIN.

The value i32::MIN is used as NA.

Rbool has the same footprint as an i32 value allowing us to use it in zero copy slices.

Implementations

impl Rbool

pub const fn true_value() -> Rbool

Return a true Rbool.

pub const fn false_value() -> Rbool

Return a false Rbool.

pub const fn na_value() -> Rbool

Return a NA Rbool.

pub fn is_true(&self) -> bool

Return true if this triboolean is true but not NA.

pub fn is_false(&self) -> bool

Return true if this triboolean is false but not NA.

pub fn to_bool(&self) -> bool

Convert this Rbool to a bool. Note NA will be true.

pub fn from_bool(val: bool) -> Self

Convert this construct a Rbool from a rust boolean.

Trait Implementations

impl<'a> AsTypedSlice<'a, Rbool> for Robj

where Self: 'a,

fn as_typed_slice(&self) -> Option<&'a [Rbool]>

fn as_typed_slice_mut(&mut self) -> Option<&'a mut [Rbool]>

impl CanBeNA for Rbool

use extendr_api::prelude::*;
test! {
    assert!((<Rbool>::na()).is_na());
}

fn is_na(&self) -> bool

Return true is the is a NA value.

fn na() -> Self

Construct a NA.

impl Clone for Rbool

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Rbool

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

Formats the value using the given formatter.

impl Default for Rbool

use extendr_api::prelude::*;
test! {
    assert_eq!(<Rbool>::default(), <bool>::default());
}

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Rbool

fn deserialize<D>(deserializer: D) -> Result<Rbool, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'de> Deserializer<'de> for Rbool

type Error = Error

The error type that can be returned if some error occurs during deserialization.

fn deserialize_any<V>(self, visitor: V) -> Result<V::Value>

where V: Visitor<'de>,

Require the Deserializer to figure out how to drive the visitor based on what data type is in the input.

fn deserialize_bool<V>( self, visitor: V, ) -> Result<V::Value, <Self as Deserializer<'de>>::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a bool value.

fn deserialize_i8<V>( self, visitor: V, ) -> Result<V::Value, <Self as Deserializer<'de>>::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting an i8 value.

fn deserialize_i16<V>( self, visitor: V, ) -> Result<V::Value, <Self as Deserializer<'de>>::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting an i16 value.

fn deserialize_i32<V>( self, visitor: V, ) -> Result<V::Value, <Self as Deserializer<'de>>::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting an i32 value.

fn deserialize_i64<V>( self, visitor: V, ) -> Result<V::Value, <Self as Deserializer<'de>>::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting an i64 value.

fn deserialize_i128<V>( self, visitor: V, ) -> Result<V::Value, <Self as Deserializer<'de>>::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting an i128 value.

fn deserialize_u8<V>( self, visitor: V, ) -> Result<V::Value, <Self as Deserializer<'de>>::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a u8 value.

fn deserialize_u16<V>( self, visitor: V, ) -> Result<V::Value, <Self as Deserializer<'de>>::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a u16 value.

fn deserialize_u32<V>( self, visitor: V, ) -> Result<V::Value, <Self as Deserializer<'de>>::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a u32 value.

fn deserialize_u64<V>( self, visitor: V, ) -> Result<V::Value, <Self as Deserializer<'de>>::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a u64 value.

fn deserialize_u128<V>( self, visitor: V, ) -> Result<V::Value, <Self as Deserializer<'de>>::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting an u128 value.

fn deserialize_f32<V>( self, visitor: V, ) -> Result<V::Value, <Self as Deserializer<'de>>::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a f32 value.

fn deserialize_f64<V>( self, visitor: V, ) -> Result<V::Value, <Self as Deserializer<'de>>::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a f64 value.

fn deserialize_char<V>( self, visitor: V, ) -> Result<V::Value, <Self as Deserializer<'de>>::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a char value.

fn deserialize_str<V>( self, visitor: V, ) -> Result<V::Value, <Self as Deserializer<'de>>::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a string value and does not benefit from taking ownership of buffered data owned by the Deserializer.

fn deserialize_string<V>( self, visitor: V, ) -> Result<V::Value, <Self as Deserializer<'de>>::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a string value and would benefit from taking ownership of buffered data owned by the Deserializer.

fn deserialize_bytes<V>( self, visitor: V, ) -> Result<V::Value, <Self as Deserializer<'de>>::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a byte array and does not benefit from taking ownership of buffered data owned by the Deserializer.

fn deserialize_byte_buf<V>( self, visitor: V, ) -> Result<V::Value, <Self as Deserializer<'de>>::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a byte array and would benefit from taking ownership of buffered data owned by the Deserializer.

fn deserialize_option<V>( self, visitor: V, ) -> Result<V::Value, <Self as Deserializer<'de>>::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting an optional value.

fn deserialize_unit<V>( self, visitor: V, ) -> Result<V::Value, <Self as Deserializer<'de>>::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a unit value.

fn deserialize_unit_struct<V>( self, name: &'static str, visitor: V, ) -> Result<V::Value, <Self as Deserializer<'de>>::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a unit struct with a particular name.

fn deserialize_newtype_struct<V>( self, name: &'static str, visitor: V, ) -> Result<V::Value, <Self as Deserializer<'de>>::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a newtype struct with a particular name.

fn deserialize_seq<V>( self, visitor: V, ) -> Result<V::Value, <Self as Deserializer<'de>>::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a sequence of values.

fn deserialize_tuple<V>( self, len: usize, visitor: V, ) -> Result<V::Value, <Self as Deserializer<'de>>::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a sequence of values and knows how many values there are without looking at the serialized data.

fn deserialize_tuple_struct<V>( self, name: &'static str, len: usize, visitor: V, ) -> Result<V::Value, <Self as Deserializer<'de>>::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a tuple struct with a particular name and number of fields.

fn deserialize_map<V>( self, visitor: V, ) -> Result<V::Value, <Self as Deserializer<'de>>::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a map of key-value pairs.

fn deserialize_struct<V>( self, name: &'static str, fields: &'static [&'static str], visitor: V, ) -> Result<V::Value, <Self as Deserializer<'de>>::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a struct with a particular name and fields.

fn deserialize_enum<V>( self, name: &'static str, variants: &'static [&'static str], visitor: V, ) -> Result<V::Value, <Self as Deserializer<'de>>::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting an enum value with a particular name and possible variants.

fn deserialize_identifier<V>( self, visitor: V, ) -> Result<V::Value, <Self as Deserializer<'de>>::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting the name of a struct field or the discriminant of an enum variant.

fn deserialize_ignored_any<V>( self, visitor: V, ) -> Result<V::Value, <Self as Deserializer<'de>>::Error>

where V: Visitor<'de>,

Hint that the Deserialize type needs to deserialize a value whose type doesn’t matter because it is ignored.

fn is_human_readable(&self) -> bool

Determine whether Deserialize implementations should expect to deserialize their human-readable form.

impl From<&i32> for Rbool

fn from(v: &i32) -> Self

Converts to this type from the input type.

impl From<Option<&i32>> for Rbool

fn from(v: Option<&i32>) -> Self

Converts to this type from the input type.

impl From<Option<bool>> for Rbool

fn from(v: Option<bool>) -> Self

Converts to this type from the input type.

impl From<Option<i32>> for Rbool

fn from(v: Option<i32>) -> Self

Converts to this type from the input type.

impl From<Rbool> for Option<bool>

fn from(v: Rbool) -> Self

Converts to this type from the input type.

impl From<bool> for Rbool

fn from(v: bool) -> Self

Converts to this type from the input type.

impl From<i32> for Rbool

fn from(v: i32) -> Self

Converts to this type from the input type.

impl FromIterator<Rbool> for Logicals

fn from_iter<T: IntoIterator<Item = Rbool>>(iter: T) -> Self

A more generalised iterator collector for small vectors. Generates a non-ALTREP vector.

impl Not for Rbool

type Output = Rbool

The resulting type after applying the ! operator.

fn not(self) -> Self::Output

Performs the unary ! operation.

impl PartialEq<Rbool> for bool

use extendr_api::prelude::*;
test! {
    assert!(<bool>::default().eq(&<Rbool>::default()));
}

fn eq(&self, other: &Rbool) -> 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 PartialEq<bool> for Rbool

use extendr_api::prelude::*;
test! {
    assert!(<Rbool>::default().eq(&<bool>::default()));
}

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

NA always fails.

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 PartialEq for Rbool

use extendr_api::prelude::*;
test! {
    assert!(<Rbool>::default().eq(&<Rbool>::default()));
    assert!(!<Rbool>::na().eq(&<Rbool>::na()));
}

fn eq(&self, other: &Rbool) -> 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 PartialOrd<Rbool> for bool

use extendr_api::prelude::*;
test! {
    assert_eq!(<Rbool>::default() <  <Rbool>::default(), false);
    assert_eq!(<Rbool>::default() <= <Rbool>::default(), true);
    assert_eq!(<Rbool>::default() >  <Rbool>::default(), false);
    assert_eq!(<Rbool>::default() >= <Rbool>::default(), true);
}

fn partial_cmp(&self, other: &Rbool) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl PartialOrd<bool> for Rbool

use extendr_api::prelude::*;
test! {
    assert_eq!(<bool>::default() <  <Rbool>::na(), false);
    assert_eq!(<bool>::default() <= <Rbool>::na(), false);
    assert_eq!(<bool>::default() >  <Rbool>::na(), false);
    assert_eq!(<bool>::default() >= <Rbool>::na(), false);
    assert_eq!(<bool>::default() <  <Rbool>::default(), false);
    assert_eq!(<bool>::default() <= <Rbool>::default(), true);
    assert_eq!(<bool>::default() >  <Rbool>::default(), false);
    assert_eq!(<bool>::default() >= <Rbool>::default(), true);
}

fn partial_cmp(&self, other: &bool) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl PartialOrd for Rbool

use extendr_api::prelude::*;
test! {
    assert_eq!(<Rbool>::default() <  <Rbool>::na(), false);
    assert_eq!(<Rbool>::default() <= <Rbool>::na(), false);
    assert_eq!(<Rbool>::default() >  <Rbool>::na(), false);
    assert_eq!(<Rbool>::default() >= <Rbool>::na(), false);
    assert_eq!(<Rbool>::default() <  <Rbool>::default(), false);
    assert_eq!(<Rbool>::default() <= <Rbool>::default(), true);
    assert_eq!(<Rbool>::default() >  <Rbool>::default(), false);
    assert_eq!(<Rbool>::default() >= <Rbool>::default(), true);
}

fn partial_cmp(&self, other: &Rbool) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Scalar<i32> for Rbool

fn inner(&self) -> i32

fn new(val: i32) -> Self

impl Serialize for Rbool

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl ToVectorValue for &Rbool

fn sexptype() -> SEXPTYPE

fn to_logical(&self) -> i32

where Self: Sized,

fn to_real(&self) -> f64

where Self: Sized,

fn to_complex(&self) -> Rcomplex

where Self: Sized,

fn to_integer(&self) -> i32

where Self: Sized,

fn to_raw(&self) -> u8

where Self: Sized,

fn to_sexp(&self) -> SEXP

where Self: Sized,

impl ToVectorValue for Rbool

fn sexptype() -> SEXPTYPE

fn to_logical(&self) -> i32

where Self: Sized,

fn to_real(&self) -> f64

where Self: Sized,

fn to_complex(&self) -> Rcomplex

where Self: Sized,

fn to_integer(&self) -> i32

where Self: Sized,

fn to_raw(&self) -> u8

where Self: Sized,

fn to_sexp(&self) -> SEXP

where Self: Sized,

impl TryFrom<&Robj> for Rbool

fn try_from(robj: &Robj) -> Result<Self>

Convert an LGLSXP object into a Rbool (tri-state boolean). Use value.is_na() to detect NA values.

type Error = Error

The type returned in the event of a conversion error.

impl TryFrom<Robj> for Rbool

type Error = Error

The type returned in the event of a conversion error.

fn try_from(robj: Robj) -> Result<Self>

Performs the conversion.

impl Copy for Rbool