Struct extendr_api::scalar::rbool::Rbool

source ·
#[repr(transparent)]
pub struct Rbool(i32);
Expand description

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.

Tuple Fields§

§0: i32

Implementations§

source§

impl Rbool

source

pub const fn true_value() -> Rbool

Return a true Rbool.

source

pub const fn false_value() -> Rbool

Return a false Rbool.

source

pub const fn na_value() -> Rbool

Return a NA Rbool.

source

pub fn is_true(&self) -> bool

Return true if this triboolean is true but not NA.

source

pub fn is_false(&self) -> bool

Return true if this triboolean is false but not NA.

source

pub fn to_bool(&self) -> bool

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

source

pub fn from_bool(val: bool) -> Self

Convert this construct a Rbool from a rust boolean.

Trait Implementations§

source§

impl<'a> AsTypedSlice<'a, Rbool> for Robj
where Self: 'a,

source§

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

source§

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

source§

impl CanBeNA for Rbool

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

fn is_na(&self) -> bool

Return true is the is a NA value.

source§

fn na() -> Self

Construct a NA.

source§

impl Clone for Rbool

source§

fn clone(&self) -> Self

Returns a copy 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 Rbool

source§

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

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

impl Default for Rbool

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

fn default() -> Self

Returns the “default value” for a type. Read more
source§

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

source§

fn deserialize<D>(deserializer: D) -> Result<Rbool, D::Error>
where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
source§

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

§

type Error = Error

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

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. Read more
source§

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.
source§

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.
source§

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.
source§

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.
source§

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.
source§

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. Read more
source§

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.
source§

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.
source§

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.
source§

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.
source§

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. Read more
source§

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.
source§

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.
source§

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.
source§

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. Read more
source§

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. Read more
source§

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. Read more
source§

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. Read more
source§

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. Read more
source§

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.
source§

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.
source§

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.
source§

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.
source§

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.
source§

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.
source§

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.
source§

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.
source§

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.
source§

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.
source§

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. Read more
source§

fn is_human_readable(&self) -> bool

Determine whether Deserialize implementations should expect to deserialize their human-readable form. Read more
source§

impl From<&i32> for Rbool

source§

fn from(v: &i32) -> Self

Converts to this type from the input type.
source§

impl From<Option<&i32>> for Rbool

source§

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

Converts to this type from the input type.
source§

impl From<Option<bool>> for Rbool

source§

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

Converts to this type from the input type.
source§

impl From<Option<i32>> for Rbool

source§

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

Converts to this type from the input type.
source§

impl From<Rbool> for Option<bool>

source§

fn from(v: Rbool) -> Self

Converts to this type from the input type.
source§

impl From<bool> for Rbool

source§

fn from(v: bool) -> Self

Converts to this type from the input type.
source§

impl From<i32> for Rbool

source§

fn from(v: i32) -> Self

Converts to this type from the input type.
source§

impl FromIterator<Rbool> for Logicals

source§

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

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

source§

impl Not for Rbool

§

type Output = Rbool

The resulting type after applying the ! operator.
source§

fn not(self) -> Self::Output

Performs the unary ! operation. Read more
source§

impl PartialEq<Rbool> for bool

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

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

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl PartialEq<bool> for Rbool

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

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

NA always fails.

1.0.0 · source§

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl PartialEq for Rbool

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

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

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

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);
}
source§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · source§

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

This method tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · source§

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

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · source§

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

This method tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · source§

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

This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more
source§

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);
}
source§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · source§

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

This method tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · source§

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

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · source§

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

This method tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · source§

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

This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more
source§

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);
}
source§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · source§

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

This method tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · source§

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

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · source§

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

This method tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · source§

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

This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more
source§

impl Scalar<i32> for Rbool

source§

fn inner(&self) -> i32

source§

fn new(val: i32) -> Self

source§

impl Serialize for Rbool

source§

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

Serialize this value into the given Serde serializer. Read more
source§

impl ToVectorValue for &Rbool

source§

fn sexptype() -> SEXPTYPE

source§

fn to_logical(&self) -> i32
where Self: Sized,

source§

fn to_real(&self) -> f64
where Self: Sized,

source§

fn to_complex(&self) -> Rcomplex
where Self: Sized,

source§

fn to_integer(&self) -> i32
where Self: Sized,

source§

fn to_raw(&self) -> u8
where Self: Sized,

source§

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

source§

impl ToVectorValue for Rbool

source§

fn sexptype() -> SEXPTYPE

source§

fn to_logical(&self) -> i32
where Self: Sized,

source§

fn to_real(&self) -> f64
where Self: Sized,

source§

fn to_complex(&self) -> Rcomplex
where Self: Sized,

source§

fn to_integer(&self) -> i32
where Self: Sized,

source§

fn to_raw(&self) -> u8
where Self: Sized,

source§

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

source§

impl TryFrom<&Robj> for Rbool

source§

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.
source§

impl TryFrom<Robj> for Rbool

§

type Error = Error

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

impl Copy for Rbool

Auto Trait Implementations§

§

impl Freeze for Rbool

§

impl RefUnwindSafe for Rbool

§

impl Send for Rbool

§

impl Sync for Rbool

§

impl Unpin for Rbool

§

impl UnwindSafe for Rbool

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> 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> 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> IntoEither for T

source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

impl<T> IntoRobj for T
where Robj: From<T>,

§

impl<T> Pointable for T

§

const ALIGN: usize = _

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
source§

impl<T> ToOwned for T
where T: Clone,

§

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>,

§

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>,

§

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.
§

impl<T> Boilerplate for T
where T: Copy + Send + Sync + Debug + PartialEq + 'static,

source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,