Struct BinaryScalar 

pub struct BinaryScalar<'a> { /* private fields */ }

A scalar value representing binary data.

This type provides a view into a binary scalar value, which can be either a valid byte buffer or null.

Implementations

impl<'a> BinaryScalar<'a>

pub fn from_scalar_value( dtype: &'a DType, value: ScalarValue, ) -> VortexResult<Self>

Creates a binary scalar from a data type and scalar value.

Errors

Returns an error if the data type is not a binary type.

pub fn dtype(&self) -> &'a DType

Returns the data type of this binary scalar.

pub fn value(&self) -> Option<ByteBuffer>

Returns the binary value as a byte buffer, or None if null.

pub fn value_ref(&self) -> Option<&ByteBuffer>

Returns a reference to the binary value, or None if null. This avoids cloning the underlying ByteBuffer.

pub fn upper_bound(self, max_length: usize) -> Option<Self>

Constructs a value at most max_length in size that’s greater than this value.

Returns None if constructing a greater value would overflow.

pub fn lower_bound(self, max_length: usize) -> Self

Construct a value at most max_length in size that’s less than ourselves.

pub fn len(&self) -> Option<usize>

Length of the scalar value or None if value is null

pub fn is_empty(&self) -> Option<bool>

Returns whether its value is non-null and empty, otherwise None.

Trait Implementations

impl<'a> Debug for BinaryScalar<'a>

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

Formats the value using the given formatter.

impl Display for BinaryScalar<'_>

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

Formats the value using the given formatter.

impl<'a> Hash for BinaryScalar<'a>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for BinaryScalar<'_>

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for BinaryScalar<'_>

fn eq(&self, other: &Self) -> 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 PartialOrd for BinaryScalar<'_>

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

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<'a> TryFrom<&'a Scalar> for BinaryScalar<'a>

type Error = VortexError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Eq for BinaryScalar<'_>