Struct DecimalDType 

pub struct DecimalDType { /* private fields */ }

Parameters that define the precision and scale of a decimal type.

Decimal types allow real numbers with a similar precision and scale to be represented exactly.

Implementations

impl DecimalDType

pub fn try_new(precision: u8, scale: i8) -> VortexResult<Self>

Fallible constructor for a DecimalDType.

Errors

Returns an error if precision exceeds MAX_PRECISION or scale is outside [MIN_SCALE, MAX_SCALE].

pub fn new(precision: u8, scale: i8) -> Self

Unchecked constructor for a DecimalDType.

Panics

Attempting to build a new instance with invalid precision or scale values will panic. Prefer using try_new for fallible construction.

pub fn precision(&self) -> u8

The precision is the number of significant figures that the decimal tracks.

pub fn scale(&self) -> i8

The scale is the maximum number of digits relative to the decimal point.

Positive scale means digits after decimal point, negative scale means number of zeros before the decimal point.

pub fn required_bit_width(&self) -> usize

Return the max number of bits required to fit a decimal with precision in.

Trait Implementations

impl Clone for DecimalDType

fn clone(&self) -> DecimalDType

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DecimalDType

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

Formats the value using the given formatter.

impl Display for DecimalDType

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

Formats the value using the given formatter.

impl Hash for DecimalDType

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 PartialEq for DecimalDType

fn eq(&self, other: &DecimalDType) -> 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 TryFrom<&DType> for DecimalDType

type Error = VortexError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<DType> for DecimalDType

type Error = VortexError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFromArrowType<&DataType> for DecimalDType

fn try_from_arrow(value: &DataType) -> VortexResult<Self>

Convert the Arrow type to a Vortex type.

impl Copy for DecimalDType

impl Eq for DecimalDType

impl StructuralPartialEq for DecimalDType