Struct ScalarValue

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

Expand description

Represents the internal data of a scalar value. Must be interpreted by wrapping up with a DType to make a Scalar.

Note that these values can be deserialized from JSON or other formats. So a PValue may not have the correct width for what the DType expects. Primitive values should therefore be read using crate::PrimitiveScalar which will handle the conversion.

Implementations§

impl ScalarValue

pub const fn null() -> Self

pub fn is_null(&self) -> bool

pub fn is_instance_of(&self, dtype: &DType) -> bool

Trait Implementations§

impl Clone for ScalarValue

fn clone(&self) -> ScalarValue

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

impl Debug for ScalarValue

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

Formats the value using the given formatter. Read more

impl Display for ScalarValue

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

Formats the value using the given formatter. Read more

impl From<&[u8]> for ScalarValue

fn from(value: &[u8]) -> Self

Converts to this type from the input type.

impl From<&str> for ScalarValue

fn from(value: &str) -> Self

Converts to this type from the input type.

impl From<Buffer<u8>> for ScalarValue

fn from(value: ByteBuffer) -> Self

Converts to this type from the input type.

impl From<BufferString> for ScalarValue

fn from(value: BufferString) -> Self

Converts to this type from the input type.

impl<T> From<Option<T>> for ScalarValue
where T: ScalarType, ScalarValue: From<T>,

fn from(value: Option<T>) -> Self

Converts to this type from the input type.

impl From<String> for ScalarValue

fn from(value: String) -> Self

Converts to this type from the input type.

impl From<Vec<Buffer<u8>>> for ScalarValue

fn from(value: Vec<ByteBuffer>) -> Self

Converts to this type from the input type.

impl From<Vec<BufferString>> for ScalarValue

fn from(value: Vec<BufferString>) -> Self

Converts to this type from the input type.

impl From<Vec<String>> for ScalarValue

fn from(value: Vec<String>) -> Self

Converts to this type from the input type.

impl From<Vec<f16>> for ScalarValue

fn from(value: Vec<f16>) -> Self

Converts to this type from the input type.

impl From<Vec<f32>> for ScalarValue

fn from(value: Vec<f32>) -> Self

Converts to this type from the input type.

impl From<Vec<f64>> for ScalarValue

fn from(value: Vec<f64>) -> Self

Converts to this type from the input type.

impl From<Vec<i16>> for ScalarValue

fn from(value: Vec<i16>) -> Self

Converts to this type from the input type.

impl From<Vec<i32>> for ScalarValue

fn from(value: Vec<i32>) -> Self

Converts to this type from the input type.

impl From<Vec<i64>> for ScalarValue

fn from(value: Vec<i64>) -> Self

Converts to this type from the input type.

impl From<Vec<i8>> for ScalarValue

fn from(value: Vec<i8>) -> Self

Converts to this type from the input type.

impl From<Vec<u16>> for ScalarValue

fn from(value: Vec<u16>) -> Self

Converts to this type from the input type.

impl From<Vec<u32>> for ScalarValue

fn from(value: Vec<u32>) -> Self

Converts to this type from the input type.

impl From<Vec<u64>> for ScalarValue

fn from(value: Vec<u64>) -> Self

Converts to this type from the input type.

impl From<Vec<usize>> for ScalarValue

fn from(value: Vec<usize>) -> Self

Converts to this type from the input type.

impl From<bool> for ScalarValue

fn from(value: bool) -> Self

Converts to this type from the input type.

impl From<f16> for ScalarValue

fn from(value: f16) -> Self

Converts to this type from the input type.

impl From<f32> for ScalarValue

fn from(value: f32) -> Self

Converts to this type from the input type.

impl From<f64> for ScalarValue

fn from(value: f64) -> Self

Converts to this type from the input type.

impl From<i16> for ScalarValue

fn from(value: i16) -> Self

Converts to this type from the input type.

impl From<i32> for ScalarValue

fn from(value: i32) -> Self

Converts to this type from the input type.

impl From<i64> for ScalarValue

fn from(value: i64) -> Self

Converts to this type from the input type.

impl From<i8> for ScalarValue

fn from(value: i8) -> Self

Converts to this type from the input type.

impl From<u16> for ScalarValue

fn from(value: u16) -> Self

Converts to this type from the input type.

impl From<u32> for ScalarValue

fn from(value: u32) -> Self

Converts to this type from the input type.

impl From<u64> for ScalarValue

fn from(value: u64) -> Self

Converts to this type from the input type.

impl From<u8> for ScalarValue

fn from(value: u8) -> Self

Converts to this type from the input type.

impl From<usize> for ScalarValue

Read a scalar as usize. For usize only, we implicitly cast for better ergonomics.

fn from(value: usize) -> Self

Converts to this type from the input type.

impl<'a> TryFrom<&'a ScalarValue> for ByteBuffer

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(scalar: &'a ScalarValue) -> VortexResult<Self>

Performs the conversion.

impl<'a> TryFrom<&'a ScalarValue> for BufferString

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(scalar: &'a ScalarValue) -> VortexResult<Self>

Performs the conversion.

impl<'a> TryFrom<&'a ScalarValue> for Option<ByteBuffer>

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(scalar: &'a ScalarValue) -> VortexResult<Self>

Performs the conversion.

impl<'a> TryFrom<&'a ScalarValue> for Option<BufferString>

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(scalar: &'a ScalarValue) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&ScalarValue> for Option<bool>

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(value: &ScalarValue) -> VortexResult<Self>

Performs the conversion.

impl TryFrom<&ScalarValue> for Option<f16>

type Error = VortexError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<&ScalarValue> for Option<f32>

type Error = VortexError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<&ScalarValue> for Option<f64>

type Error = VortexError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<&ScalarValue> for Option<i16>

type Error = VortexError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<&ScalarValue> for Option<i32>

type Error = VortexError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<&ScalarValue> for Option<i64>

type Error = VortexError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<&ScalarValue> for Option<i8>

type Error = VortexError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<&ScalarValue> for Option<u16>

type Error = VortexError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<&ScalarValue> for Option<u32>

type Error = VortexError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<&ScalarValue> for Option<u64>

type Error = VortexError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<&ScalarValue> for Option<u8>

type Error = VortexError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<'a> TryFrom<&'a ScalarValue> for String

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(value: &'a ScalarValue) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a, T: for<'b> TryFrom<&'b ScalarValue, Error = VortexError>> TryFrom<&'a ScalarValue> for Vec<T>

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(value: &'a ScalarValue) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&ScalarValue> for bool

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(value: &ScalarValue) -> VortexResult<Self>

Performs the conversion.

impl TryFrom<&ScalarValue> for f16

type Error = VortexError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<&ScalarValue> for f32

type Error = VortexError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<&ScalarValue> for f64

type Error = VortexError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<&ScalarValue> for i16

type Error = VortexError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<&ScalarValue> for i32

type Error = VortexError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<&ScalarValue> for i64

type Error = VortexError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<&ScalarValue> for i8

type Error = VortexError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<&ScalarValue> for u16

type Error = VortexError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<&ScalarValue> for u32

type Error = VortexError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<&ScalarValue> for u64

type Error = VortexError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<&ScalarValue> for u8

type Error = VortexError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<&ScalarValue> for usize

Read a scalar as usize. For usize only, we implicitly cast for better ergonomics.

type Error = VortexError

The type returned in the event of a conversion error.

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

Performs the conversion.

Auto Trait Implementations§

impl Freeze for ScalarValue

impl RefUnwindSafe for ScalarValue

impl Send for ScalarValue

impl Sync for ScalarValue

impl Unpin for ScalarValue

impl UnwindSafe for ScalarValue

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> ArchivePointee for T

type ArchivedMetadata = ()

The archived version of the pointer metadata for this type.

fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata, ) -> <T as Pointee>::Metadata

Converts some archived metadata to the pointer metadata for itself.

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

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

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> IntoEither for T

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

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

impl<T> LayoutRaw for T

fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>

Returns the layout of the type.

impl<T, N1, N2> Niching<NichedOption<T, N1>> for N2
where T: SharedNiching<N1, N2>, N1: Niching<T>, N2: Niching<T>,

unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool

Returns whether the given value has been niched. Read more

fn resolve_niched(out: Place<NichedOption<T, N1>>)

Writes data to out indicating that a T is niched.

impl<T> Pointee for T

type Metadata = ()

The metadata type for pointers and references to this type.

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T> ToString for T
where T: Display + ?Sized,

fn to_string(&self) -> String

Converts the given value to a String. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

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.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,

impl<T> ErasedDestructor for T
where T: 'static,

impl<T> MaybeSendSync for T