1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432
//! Conversions to Robj
use super::*;
macro_rules! impl_try_from_scalar_integer {
($t:ty) => {
impl TryFrom<&Robj> for $t {
type Error = Error;
/// Convert a numeric object to an integer value.
fn try_from(robj: &Robj) -> Result<Self> {
// Check if the value is a scalar
match robj.len() {
0 => return Err(Error::ExpectedNonZeroLength(robj.clone())),
1 => {}
_ => return Err(Error::ExpectedScalar(robj.clone())),
};
// Check if the value is not a missing value
if robj.is_na() {
return Err(Error::MustNotBeNA(robj.clone()));
}
// If the conversion is int-to-int, check the limits. This
// needs to be done by `TryFrom` because the conversion by `as`
// is problematic when converting a negative value to unsigned
// integer types (e.g. `-1i32 as u8` becomes 255).
if let Some(v) = robj.as_integer() {
if let Ok(v) = Self::try_from(v) {
return Ok(v);
} else {
return Err(Error::OutOfLimits(robj.clone()));
}
}
// If the conversion is float-to-int, check if the value is
// integer-like (i.e., an integer, or a float representing a
// whole number). This needs to be down with `as`, as no
// `TryFrom` is implemented for float types. `FloatToInt` trait
// might eventually become available in future, though.
if let Some(v) = robj.as_real() {
let result = v as Self;
if (result as f64 - v).abs() < f64::EPSILON {
return Ok(result);
} else {
return Err(Error::ExpectedWholeNumber(robj.clone()));
}
}
Err(Error::ExpectedNumeric(robj.clone()))
}
}
};
}
macro_rules! impl_try_from_scalar_real {
($t:ty) => {
impl TryFrom<&Robj> for $t {
type Error = Error;
/// Convert a numeric object to a real value.
fn try_from(robj: &Robj) -> Result<Self> {
// Check if the value is a scalar
match robj.len() {
0 => return Err(Error::ExpectedNonZeroLength(robj.clone())),
1 => {}
_ => return Err(Error::ExpectedScalar(robj.clone())),
};
// Check if the value is not a missing value
if robj.is_na() {
return Err(Error::MustNotBeNA(robj.clone()));
}
// <Robj>::as_xxx() methods can work only when the underlying
// SEXP is the corresponding type, so we cannot use as_real()
// directly on INTSXP.
if let Some(v) = robj.as_real() {
return Ok(v as Self);
}
if let Some(v) = robj.as_integer() {
return Ok(v as Self);
}
Err(Error::ExpectedNumeric(robj.clone()))
}
}
};
}
impl_try_from_scalar_integer!(u8);
impl_try_from_scalar_integer!(u16);
impl_try_from_scalar_integer!(u32);
impl_try_from_scalar_integer!(u64);
impl_try_from_scalar_integer!(usize);
impl_try_from_scalar_integer!(i8);
impl_try_from_scalar_integer!(i16);
impl_try_from_scalar_integer!(i32);
impl_try_from_scalar_integer!(i64);
impl_try_from_scalar_integer!(isize);
impl_try_from_scalar_real!(f32);
impl_try_from_scalar_real!(f64);
impl TryFrom<&Robj> for bool {
type Error = Error;
/// Convert an LGLSXP object into a boolean.
/// NAs are not allowed.
fn try_from(robj: &Robj) -> Result<Self> {
if robj.is_na() {
Err(Error::MustNotBeNA(robj.clone()))
} else {
Ok(<Rbool>::try_from(robj)?.is_true())
}
}
}
impl TryFrom<&Robj> for &str {
type Error = Error;
/// Convert a scalar STRSXP object into a string slice.
/// NAs are not allowed.
fn try_from(robj: &Robj) -> Result<Self> {
if robj.is_na() {
return Err(Error::MustNotBeNA(robj.clone()));
}
match robj.len() {
0 => Err(Error::ExpectedNonZeroLength(robj.clone())),
1 => {
if let Some(s) = robj.as_str() {
Ok(s)
} else {
Err(Error::ExpectedString(robj.clone()))
}
}
_ => Err(Error::ExpectedScalar(robj.clone())),
}
}
}
impl TryFrom<&Robj> for String {
type Error = Error;
/// Convert an scalar STRSXP object into a String.
/// Note: Unless you plan to store the result, use a string slice instead.
/// NAs are not allowed.
fn try_from(robj: &Robj) -> Result<Self> {
<&str>::try_from(robj).map(|s| s.to_string())
}
}
impl TryFrom<&Robj> for Vec<i32> {
type Error = Error;
/// Convert an INTSXP object into a vector of i32 (integer).
/// Note: Unless you plan to store the result, use a slice instead.
/// Use `value.is_na()` to detect NA values.
fn try_from(robj: &Robj) -> Result<Self> {
if let Some(v) = robj.as_typed_slice() {
// TODO: check NAs
Ok(Vec::from(v))
} else {
Err(Error::ExpectedInteger(robj.clone()))
}
}
}
impl TryFrom<&Robj> for Vec<f64> {
type Error = Error;
/// Convert a REALSXP object into a vector of f64 (double precision floating point).
/// Note: Unless you plan to store the result, use a slice instead.
/// Use `value.is_na()` to detect NA values.
fn try_from(robj: &Robj) -> Result<Self> {
if let Some(v) = robj.as_typed_slice() {
// TODO: check NAs
Ok(Vec::from(v))
} else {
Err(Error::ExpectedReal(robj.clone()))
}
}
}
impl TryFrom<&Robj> for Vec<u8> {
type Error = Error;
/// Convert a RAWSXP object into a vector of bytes.
/// Note: Unless you plan to store the result, use a slice instead.
fn try_from(robj: &Robj) -> Result<Self> {
if let Some(v) = robj.as_typed_slice() {
Ok(Vec::from(v))
} else {
Err(Error::ExpectedRaw(robj.clone()))
}
}
}
impl TryFrom<&Robj> for Vec<Rint> {
type Error = Error;
/// Convert an INTSXP object into a vector of i32 (integer).
/// Note: Unless you plan to store the result, use a slice instead.
/// Use `value.is_na()` to detect NA values.
fn try_from(robj: &Robj) -> Result<Self> {
if let Some(v) = robj.as_typed_slice() {
Ok(Vec::from(v))
} else {
Err(Error::ExpectedInteger(robj.clone()))
}
}
}
impl TryFrom<&Robj> for Vec<Rfloat> {
type Error = Error;
/// Convert a REALSXP object into a vector of f64 (double precision floating point).
/// Note: Unless you plan to store the result, use a slice instead.
/// Use `value.is_na()` to detect NA values.
fn try_from(robj: &Robj) -> Result<Self> {
if let Some(v) = robj.as_typed_slice() {
Ok(Vec::from(v))
} else {
Err(Error::ExpectedReal(robj.clone()))
}
}
}
impl TryFrom<&Robj> for Vec<Rbool> {
type Error = Error;
/// Convert a LGLSXP object into a vector of Rbool (tri-state booleans).
/// Note: Unless you plan to store the result, use a slice instead.
/// Use `value.is_na()` to detect NA values.
fn try_from(robj: &Robj) -> Result<Self> {
if let Some(v) = robj.as_typed_slice() {
Ok(Vec::from(v))
} else {
Err(Error::ExpectedInteger(robj.clone()))
}
}
}
impl TryFrom<&Robj> for Vec<Rcplx> {
type Error = Error;
/// Convert a complex object into a vector of Rcplx.
fn try_from(robj: &Robj) -> Result<Self> {
if let Some(v) = robj.as_typed_slice() {
Ok(Vec::from(v))
} else {
Err(Error::ExpectedComplex(robj.clone()))
}
}
}
impl TryFrom<&Robj> for Vec<String> {
type Error = Error;
/// Convert a STRSXP object into a vector of `String`s.
/// Note: Unless you plan to store the result, use a slice instead.
fn try_from(robj: &Robj) -> Result<Self> {
if let Some(iter) = robj.as_str_iter() {
// check for NA's in the string vector
if iter.clone().any(|s| s.is_na()) {
Err(Error::MustNotBeNA(robj.clone()))
} else {
Ok(iter.map(|s| s.to_string()).collect::<Vec<String>>())
}
} else {
Err(Error::ExpectedString(robj.clone()))
}
}
}
impl TryFrom<&Robj> for &[i32] {
type Error = Error;
/// Convert an INTSXP object into a slice of i32 (integer).
/// Use `value.is_na()` to detect NA values.
fn try_from(robj: &Robj) -> Result<Self> {
robj.as_typed_slice()
.ok_or_else(|| Error::ExpectedInteger(robj.clone()))
}
}
impl TryFrom<&Robj> for &[Rint] {
type Error = Error;
/// Convert an integer object into a slice of Rint (tri-state booleans).
/// Use `value.is_na()` to detect NA values.
fn try_from(robj: &Robj) -> Result<Self> {
robj.as_typed_slice()
.ok_or_else(|| Error::ExpectedInteger(robj.clone()))
}
}
impl TryFrom<&Robj> for &[Rfloat] {
type Error = Error;
/// Convert a doubles object into a slice of Rfloat (tri-state booleans).
/// Use `value.is_na()` to detect NA values.
fn try_from(robj: &Robj) -> Result<Self> {
robj.as_typed_slice()
.ok_or_else(|| Error::ExpectedReal(robj.clone()))
}
}
impl TryFrom<&Robj> for &[Rbool] {
type Error = Error;
/// Convert a logical object into a slice of Rbool (tri-state booleans).
/// Use `value.is_na()` to detect NA values.
fn try_from(robj: &Robj) -> Result<Self> {
robj.as_typed_slice()
.ok_or_else(|| Error::ExpectedLogical(robj.clone()))
}
}
impl TryFrom<&Robj> for &[Rcplx] {
type Error = Error;
/// Convert a complex object into a slice of Rbool
/// Use `value.is_na()` to detect NA values.
fn try_from(robj: &Robj) -> Result<Self> {
robj.as_typed_slice()
.ok_or_else(|| Error::ExpectedComplex(robj.clone()))
}
}
impl TryFrom<&Robj> for &[u8] {
type Error = Error;
/// Convert a RAWSXP object into a slice of bytes.
fn try_from(robj: &Robj) -> Result<Self> {
robj.as_typed_slice()
.ok_or_else(|| Error::ExpectedRaw(robj.clone()))
}
}
impl TryFrom<&Robj> for &[f64] {
type Error = Error;
/// Convert a REALSXP object into a slice of f64 (double precision floating point).
/// Use `value.is_na()` to detect NA values.
fn try_from(robj: &Robj) -> Result<Self> {
robj.as_typed_slice()
.ok_or_else(|| Error::ExpectedReal(robj.clone()))
}
}
impl TryFrom<&Robj> for Rcplx {
type Error = Error;
fn try_from(robj: &Robj) -> Result<Self> {
// Check if the value is a scalar
match robj.len() {
0 => return Err(Error::ExpectedNonZeroLength(robj.clone())),
1 => {}
_ => return Err(Error::ExpectedScalar(robj.clone())),
};
// Check if the value is not a missing value.
if robj.is_na() {
return Ok(Rcplx::na());
}
// This should always work, NA is handled above.
if let Some(v) = robj.as_real() {
return Ok(Rcplx::from(v));
}
// Any integer (32 bit) can be represented as f64,
// this always works.
if let Some(v) = robj.as_integer() {
return Ok(Rcplx::from(v as f64));
}
// Complex slices return their first element.
if let Some(s) = robj.as_typed_slice() {
return Ok(s[0]);
}
Err(Error::ExpectedComplex(robj.clone()))
}
}
// Convert TryFrom<&Robj> into TryFrom<Robj>. Sadly, we are unable to make a blanket
// conversion using GetSexp with the current version of Rust.
macro_rules! impl_try_from_robj {
($($type : ty)*) => {
$(
impl TryFrom<Robj> for $type {
type Error = Error;
fn try_from(robj: Robj) -> Result<Self> {
<$type>::try_from(&robj)
}
}
impl TryFrom<&Robj> for Option<$type> {
type Error = Error;
fn try_from(robj: &Robj) -> Result<Self> {
if robj.is_null() || robj.is_na() {
Ok(None)
} else {
Ok(Some(<$type>::try_from(robj)?))
}
}
}
impl TryFrom<Robj> for Option<$type> {
type Error = Error;
fn try_from(robj: Robj) -> Result<Self> {
<Option::<$type>>::try_from(&robj)
}
}
)*
}
}
impl_try_from_robj!(
u8 u16 u32 u64 usize
i8 i16 i32 i64 isize
bool
Rint Rfloat Rbool Rcplx
f32 f64
Vec::<Rint> Vec::<Rfloat> Vec::<Rbool> Vec::<Rcplx> Vec::<u8> Vec::<i32> Vec::<f64>
&[Rint] &[Rfloat] &[Rbool] &[Rcplx] &[u8] &[i32] &[f64]
&str String
);