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
//! C-compatible result type.
use super::error::{self, Error};
use super::num::Number;
/// C-compatible result type from parsing strings-to-numbers for FFI.
#[repr(C)]
#[derive(Copy, Clone, Debug, PartialEq)]
pub struct Result<T: Number> {
/// Value from the parser function call.
pub value: T,
/// Error information, including the error code and other metadata.
pub error: Error,
}
/// Helper function to create a success message.
#[inline(always)]
pub(crate) fn success<T>(value: T)
-> Result<T>
where T: Number
{
Result { value: value, error: error::success() }
}
/// Helper function to create an overflow error.
#[inline(always)]
pub(crate) fn overflow_error<T>(value: T)
-> Result<T>
where T: Number
{
Result { value: value, error: error::overflow_error() }
}
/// Helper function to create an invalid digit error.
#[inline(always)]
pub(crate) fn invalid_digit_error<T>(value: T, index: usize)
-> Result<T>
where T: Number
{
Result { value: value, error: error::invalid_digit_error(index) }
}
// FFI
// Manually expand the templates for all known result types, since
// no other language has Rust-compatible generics.
/// Expanded generic for a result type containing a value of type u8.
pub type U8Result = Result<u8>;
/// Expanded generic for a result type containing a value of type u16.
pub type U16Result = Result<u16>;
/// Expanded generic for a result type containing a value of type u32.
pub type U32Result = Result<u32>;
/// Expanded generic for a result type containing a value of type u64.
pub type U64Result = Result<u64>;
/// Expanded generic for a result type containing a value of type u128.
pub type U128Result = Result<u128>;
/// Expanded generic for a result type containing a value of type usize.
pub type UsizeResult = Result<usize>;
/// Expanded generic for a result type containing a value of type i8.
pub type I8Result = Result<i8>;
/// Expanded generic for a result type containing a value of type i16.
pub type I16Result = Result<i16>;
/// Expanded generic for a result type containing a value of type i32.
pub type I32Result = Result<i32>;
/// Expanded generic for a result type containing a value of type i64.
pub type I64Result = Result<i64>;
/// Expanded generic for a result type containing a value of type i128.
pub type I128Result = Result<i128>;
/// Expanded generic for a result type containing a value of type isize.
pub type IsizeResult = Result<isize>;
/// Expanded generic for a result type containing a value of type f32.
pub type F32Result = Result<f32>;
/// Expanded generic for a result type containing a value of type f64.
pub type F64Result = Result<f64>;