Struct Value

pub struct Value { /* private fields */ }

A NaN-tagged value supporting f64, i32, u32, booleans, null and arbitrary pointers.

Usage

The Value type can be constructed from f64, bool, i32, u32, i64, () and pointers to arbitrary T:

use nanoval::Value;

let double = Value::from(3.14);
let integer = Value::from(42);
let boolean = Value::from(true);
let null = Value::from(());
let pointee = 42;
let pointer = Value::try_from(&pointee as *const i32).unwrap();

The constructed value can be converted back to the original type:

assert_eq!(double.as_f64(), Some(3.14));
assert_eq!(integer.as_int(), Some(42));
assert_eq!(boolean.as_bool(), Some(true));
assert!(null.is_null());
assert_eq!(pointer.as_pointer::<i32>(), Some(&pointee as *const i32));

Implementations

impl Value

pub const fn is_f64(self) -> bool

Is this value a f64? Valid f64 are not NaN, or if they are, they have a specific bit pattern.

pub const fn is_int(self) -> bool

Is this value an integer?

pub const fn is_bool(self) -> bool

Is this value a boolean?

pub const fn is_pointer(self) -> bool

Is this value a pointer?

pub const fn is_null(self) -> bool

Is this value null?

pub fn as_f64(self) -> Option<f64>

Get the value as a f64.

pub const fn as_int(self) -> Option<i64>

Get the value as an integer.

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

Get the value as a boolean.

pub const fn as_pointer<T>(self) -> Option<*const T>

Get the value as a pointer.

pub fn as_f64_unchecked(self) -> f64

Unchecked conversion to f64.

Safety

Conversion to f64 is always safe, but might return NaN.

pub const unsafe fn as_int_unchecked(self) -> i64

Unchecked conversion to integer.

Safety

The caller must be certain that the value is an integer.

pub const unsafe fn as_bool_unchecked(self) -> bool

Unchecked conversion to boolean.

Safety

The caller must be certain that the value is a boolean.

pub const unsafe fn as_pointer_unchecked<T>(self) -> *const T

Unchecked conversion to pointer.

Safety

The caller must be certain that the value is a pointer.

pub const unsafe fn as_ref<'a, T>(self) -> &'a T

Unchecked conversion to reference.

Safety

The caller must be certain that the value is a pointer.

Trait Implementations

impl Clone for Value

fn clone(&self) -> Value

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Value

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

Formats the value using the given formatter.

impl Display for Value

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

Formats the value using the given formatter.

impl From<()> for Value

fn from(_: ()) -> Self

Converts to this type from the input type.

impl From<bool> for Value

fn from(value: bool) -> Self

Converts to this type from the input type.

impl From<f64> for Value

fn from(value: f64) -> Self

Converts to this type from the input type.

impl From<i32> for Value

fn from(value: i32) -> Self

Converts to this type from the input type.

impl From<u32> for Value

fn from(value: u32) -> Self

Converts to this type from the input type.

impl PartialEq for Value

fn eq(&self, other: &Value) -> 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<T> TryFrom<*const T> for Value

type Error = ()

The type returned in the event of a conversion error.

fn try_from(value: *const T) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<i64> for Value

type Error = ()

The type returned in the event of a conversion error.

fn try_from(value: i64) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for Value

impl Eq for Value

impl StructuralPartialEq for Value