Skip to main content

Decimal

Struct Decimal 

Source
pub struct Decimal { /* private fields */ }
Expand description

A DuckDB DECIMAL(width, scale) value.

value stores the scaled integer payload. For example, 123.45::DECIMAL(9, 2) is represented as Decimal::new(9, 2, 12345)?.

The declared width is preserved when reading and writing DuckDB DECIMAL columns. Values converted from non-decimal sources, such as integers or rust_decimal values, infer the smallest width that can represent the scaled payload. Width is not part of equality or hashing: values with the same scale and scaled integer payload compare equal even if they arrived through paths with different declared widths. Use Decimal::width when the declared width matters; Eq and Hash do not preserve it.

Scale is part of identity: DECIMAL(2, 1) with payload 12 and DECIMAL(3, 2) with payload 120 compare different. Decimal intentionally does not implement Ord or PartialOrd; sort in SQL or compare an explicitly normalized representation when ordering is needed.

Implementations§

Source§

impl Decimal

Source

pub const MAX_WIDTH: u8 = 38

DuckDB’s maximum DECIMAL width.

Source

pub fn new(width: u8, scale: u8, value: i128) -> Result<Self, DecimalError>

Builds a valid DECIMAL(width, scale) wrapper.

Returns DecimalError when width is outside DuckDB’s 1..=38 range, scale is larger than width, or value has more digits than width allows.

Source

pub const fn width(self) -> u8

Returns the declared precision for DuckDB DECIMAL values.

Values converted from non-decimal sources infer the smallest width that can represent the scaled payload.

Source

pub const fn scale(self) -> u8

Returns the number of fractional digits.

Source

pub const fn value(self) -> i128

Returns the scaled integer payload.

Trait Implementations§

Source§

impl Clone for Decimal

Source§

fn clone(&self) -> Decimal

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for Decimal

Source§

impl Debug for Decimal

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for Decimal

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for Decimal

Source§

impl From<Decimal> for Value

Source§

fn from(decimal: Decimal) -> Self

Converts to this type from the input type.
Source§

impl From<Decimal> for ValueRef<'_>

Source§

fn from(decimal: Decimal) -> Self

Converts to this type from the input type.
Source§

impl FromSql for Decimal

Source§

fn column_result(value: ValueRef<'_>) -> FromSqlResult<Self>

Converts DuckDB value into Rust value.
Source§

impl Hash for Decimal

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for Decimal

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl ToSql for Decimal

Source§

fn to_sql(&self) -> Result<ToSqlOutput<'_>>

Converts Rust value to DuckDB value

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

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

Source§

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
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

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

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

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

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

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

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

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

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

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

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

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.