risingwave_meta_model_migration::sea_orm::entity::prelude

Struct BigDecimal

pub struct BigDecimal {
    pub(crate) int_val: BigInt,
    pub(crate) scale: i64,
}

Expand description

A big decimal type.

Fields§

§int_val: BigInt§scale: i64

Implementations§

§

impl BigDecimal

pub fn new(digits: BigInt, scale: i64) -> BigDecimal

Creates and initializes a BigDecimal.

The more explicit method from_bigint should be preferred, as new may change in the future.

pub fn from_bigint(digits: BigInt, scale: i64) -> BigDecimal

Construct BigDecimal from BigInt and a scale

pub fn from_biguint(digits: BigUint, scale: i64) -> BigDecimal

Construct positive BigDecimal from BigUint and a scale

pub fn to_ref(&self) -> BigDecimalRef<'_>

Make a BigDecimalRef of this value

pub fn fractional_digit_count(&self) -> i64

Returns the scale of the BigDecimal, the total number of digits to the right of the decimal point (including insignificant leading zeros)

§Examples

use bigdecimal::BigDecimal;
use std::str::FromStr;

let a = BigDecimal::from(12345);  // No fractional part
let b = BigDecimal::from_str("123.45").unwrap();  // Fractional part
let c = BigDecimal::from_str("0.0000012345").unwrap();  // Completely fractional part
let d = BigDecimal::from_str("5e9").unwrap();  // Negative-fractional part

assert_eq!(a.fractional_digit_count(), 0);
assert_eq!(b.fractional_digit_count(), 2);
assert_eq!(c.fractional_digit_count(), 10);
assert_eq!(d.fractional_digit_count(), -9);

pub fn parse_bytes(buf: &[u8], radix: u32) -> Option<BigDecimal>

Creates and initializes a BigDecimal.

Decodes using str::from_utf8 and forwards to BigDecimal::from_str_radix. Only base-10 is supported.

§Examples

use bigdecimal::{BigDecimal, Zero};

assert_eq!(BigDecimal::parse_bytes(b"0", 10).unwrap(), BigDecimal::zero());
assert_eq!(BigDecimal::parse_bytes(b"13", 10).unwrap(), BigDecimal::from(13));

pub fn with_scale(&self, new_scale: i64) -> BigDecimal

Return a new BigDecimal object equivalent to self, with internal scaling set to the number specified. If the new_scale is lower than the current value (indicating a larger power of 10), digits will be dropped (as precision is lower)

pub fn with_scale_round(&self, new_scale: i64, mode: RoundingMode) -> BigDecimal

Return a new BigDecimal after shortening the digits and rounding


let n: BigDecimal = "129.41675".parse().unwrap();

assert_eq!(n.with_scale_round(2, RoundingMode::Up),  "129.42".parse().unwrap());
assert_eq!(n.with_scale_round(-1, RoundingMode::Down),  "120".parse().unwrap());
assert_eq!(n.with_scale_round(4, RoundingMode::HalfEven),  "129.4168".parse().unwrap());

pub fn with_prec(&self, prec: u64) -> BigDecimal

Return a new BigDecimal object with precision set to new value


let n: BigDecimal = "129.41675".parse().unwrap();

assert_eq!(n.with_prec(2),  "130".parse().unwrap());

let n_p12 = n.with_prec(12);
let (i, scale) = n_p12.as_bigint_and_exponent();
assert_eq!(n_p12, "129.416750000".parse().unwrap());
assert_eq!(i, 129416750000_u64.into());
assert_eq!(scale, 9);

pub fn with_precision_round( &self, prec: NonZero<u64>, round: RoundingMode, ) -> BigDecimal

Return this BigDecimal with the given precision, rounding if needed

pub fn sign(&self) -> Sign

Return the sign of the BigDecimal as num::bigint::Sign.


fn sign_of(src: &str) -> Sign {
   let n: BigDecimal = src.parse().unwrap();
   n.sign()
}

assert_eq!(sign_of("-1"), Sign::Minus);
assert_eq!(sign_of("0"),  Sign::NoSign);
assert_eq!(sign_of("1"),  Sign::Plus);

pub fn as_bigint_and_exponent(&self) -> (BigInt, i64)

Return the internal big integer value and an exponent. Note that a positive exponent indicates a negative power of 10.

§Examples

use bigdecimal::{BigDecimal, num_bigint::BigInt};

let n: BigDecimal = "1.23456".parse().unwrap();
let expected = ("123456".parse::<BigInt>().unwrap(), 5);
assert_eq!(n.as_bigint_and_exponent(), expected);

pub fn into_bigint_and_scale(self) -> (BigInt, i64)

Take BigDecimal and split into num::BigInt of digits, and the scale

Scale is number of digits after the decimal point, can be negative.

pub fn as_bigint_and_scale(&self) -> (Cow<'_, BigInt>, i64)

Return digits as borrowed Cow of integer digits, and its scale

Scale is number of digits after the decimal point, can be negative.

pub fn into_bigint_and_exponent(self) -> (BigInt, i64)

Convert into the internal big integer value and an exponent. Note that a positive exponent indicates a negative power of 10.

§Examples

use bigdecimal::{BigDecimal, num_bigint::BigInt};

let n: BigDecimal = "1.23456".parse().unwrap();
let expected = ("123456".parse::<num_bigint::BigInt>().unwrap(), 5);
assert_eq!(n.into_bigint_and_exponent(), expected);

pub fn digits(&self) -> u64

Number of digits in the non-scaled integer representation

pub fn abs(&self) -> BigDecimal

Compute the absolute value of number

let n: BigDecimal = "123.45".parse().unwrap();
assert_eq!(n.abs(), "123.45".parse().unwrap());

let n: BigDecimal = "-123.45".parse().unwrap();
assert_eq!(n.abs(), "123.45".parse().unwrap());

pub fn double(&self) -> BigDecimal

Multiply decimal by 2 (efficiently)

let n: BigDecimal = "123.45".parse().unwrap();
assert_eq!(n.double(), "246.90".parse().unwrap());

pub fn half(&self) -> BigDecimal

Divide decimal by 2 (efficiently)

Note: If the last digit in the decimal is odd, the precision will increase by 1

let n: BigDecimal = "123.45".parse().unwrap();
assert_eq!(n.half(), "61.725".parse().unwrap());

pub fn square(&self) -> BigDecimal

Square a decimal: x²

No rounding or truncating of digits; this is the full result of the squaring operation.

Note: doubles the scale of bigdecimal, which might lead to accidental exponential-complexity if used in a loop.

let n: BigDecimal = "1.1156024145937225657484".parse().unwrap();
assert_eq!(n.square(), "1.24456874744734405154288399835406316085210256".parse().unwrap());

let n: BigDecimal = "-9.238597585E+84".parse().unwrap();
assert_eq!(n.square(), "8.5351685337567832225E+169".parse().unwrap());

pub fn cube(&self) -> BigDecimal

Cube a decimal: x³

No rounding or truncating of digits; this is the full result of the cubing operation.

Note: triples the scale of bigdecimal, which might lead to accidental exponential-complexity if used in a loop.

let n: BigDecimal = "1.1156024145937225657484".parse().unwrap();
assert_eq!(n.cube(), "1.388443899780141911774491376394890472130000455312878627147979955904".parse().unwrap());

let n: BigDecimal = "-9.238597585E+84".parse().unwrap();
assert_eq!(n.cube(), "-7.88529874035334084567570176625E+254".parse().unwrap());

pub fn sqrt(&self) -> Option<BigDecimal>

Take the square root of the number

Uses default-precision, set from build time environment variable

If the value is < 0, None is returned

let n: BigDecimal = "1.1156024145937225657484".parse().unwrap();
assert_eq!(n.sqrt().unwrap(), "1.056220817156016181190291268045893004363809142172289919023269377496528394924695970851558013658193913".parse().unwrap());

let n: BigDecimal = "-9.238597585E+84".parse().unwrap();
assert_eq!(n.sqrt(), None);

pub fn sqrt_with_context(&self, ctx: &Context) -> Option<BigDecimal>

Take the square root of the number, using context for precision and rounding

pub fn cbrt(&self) -> BigDecimal

Take the cube root of the number, using default context

pub fn cbrt_with_context(&self, ctx: &Context) -> BigDecimal

Take cube root of self, using properties of context

pub fn inverse(&self) -> BigDecimal

Compute the reciprical of the number: x^-1

pub fn inverse_with_context(&self, ctx: &Context) -> BigDecimal

Return inverse of self, rounding with ctx

pub fn round(&self, round_digits: i64) -> BigDecimal

Return given number rounded to ‘round_digits’ precision after the decimal point, using default rounding mode

Default rounding mode is HalfEven, but can be configured at compile-time by the environment variable: RUST_BIGDECIMAL_DEFAULT_ROUNDING_MODE (or by patching build.rs )

pub fn is_integer(&self) -> bool

Return true if this number has zero fractional part (is equal to an integer)

pub fn exp(&self) -> BigDecimal

Evaluate the natural-exponential function e^x

pub fn normalized(&self) -> BigDecimal

pub fn to_plain_string(&self) -> String

Create string of decimal in standard decimal notation.

Unlike standard formatter, this never prints the number in scientific notation.

§Panics

If the magnitude of the exponent is very large, this may cause out-of-memory errors, or overflowing panics.

§Examples

let n: BigDecimal = "123.45678".parse().unwrap();
assert_eq!(&n.to_plain_string(), "123.45678");

let n: BigDecimal = "1e-10".parse().unwrap();
assert_eq!(&n.to_plain_string(), "0.0000000001");

pub fn write_plain_string<W>(&self, wtr: &mut W) -> Result<(), Error>
where W: Write,

Write decimal value in decimal notation to the writer object.

§Panics

If the exponent is very large or very small, the number of this will print that many trailing or leading zeros. If exabytes, this will likely panic.

pub fn to_scientific_notation(&self) -> String

Create string of this bigdecimal in scientific notation

let n = BigDecimal::from(12345678);
assert_eq!(&n.to_scientific_notation(), "1.2345678e7");

pub fn write_scientific_notation<W>(&self, w: &mut W) -> Result<(), Error>
where W: Write,

Write bigdecimal in scientific notation to writer w

pub fn to_engineering_notation(&self) -> String

Create string of this bigdecimal in engineering notation

Engineering notation is scientific notation with the exponent coerced to a multiple of three

let n = BigDecimal::from(12345678);
assert_eq!(&n.to_engineering_notation(), "12.345678e6");

pub fn write_engineering_notation<W>(&self, w: &mut W) -> Result<(), Error>
where W: Write,

Write bigdecimal in engineering notation to writer w

Performs copy-assignment from source. Read more

§

impl Debug for BigDecimal

§

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

Formats the value using the given formatter. Read more

§

impl Decode<'_, MySql> for BigDecimal

§

fn decode( value: MySqlValueRef<'_>, ) -> Result<BigDecimal, Box<dyn Error + Sync + Send>>

Decode a new value of this type using a raw value from the database.

§

impl Decode<'_, Postgres> for BigDecimal

§Note: `NaN`

BigDecimal has a greater range than NUMERIC (see the corresponding Encode impl for details) but cannot represent NaN, so decoding may return an error.

§Note: `BigDecimal` Has a Larger Range than `NUMERIC`

BigDecimal can represent values with a far, far greater range than the NUMERIC type in Postgres can.

NUMERIC is limited to 131,072 digits before the decimal point, and 16,384 digits after it. See Section 8.1, Numeric Types of the Postgres manual for details.

Meanwhile, BigDecimal can theoretically represent a value with an arbitrary number of decimal digits, albeit with a maximum of 2⁶³ significant figures.

Because encoding in the current API design must be infallible, when attempting to encode a BigDecimal that cannot fit in the wire representation of NUMERIC, SQLx may instead encode a sentinel value that falls outside the allowed range but is still representable.

This will cause the query to return a DatabaseError with code 22P03 (invalid_binary_representation) and the error message invalid scale in external "numeric" value (though this may be subject to change).

However, BigDecimal should be able to decode any NUMERIC value except NaN, for which it has no representation.

§

fn encode_by_ref( &self, buf: &mut PgArgumentBuffer, ) -> Result<IsNull, Box<dyn Error + Sync + Send>>

Writes the value of self into buf without moving self. Read more

§

fn size_hint(&self) -> usize

§

fn encode( self, buf: &mut <DB as Database>::ArgumentBuffer<'q>, ) -> Result<IsNull, Box<dyn Error + Sync + Send>>
where Self: Sized,

Writes the value of self into buf in the expected format for the database.

§

§

type Err = ParseBigDecimalError

The associated error which can be returned from parsing.

§

fn from_str(s: &str) -> Result<BigDecimal, ParseBigDecimalError>

Parses a string s to return a value of this type. Read more

§

impl Hash for BigDecimal

§

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

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

§

impl Neg for BigDecimal

§

type Output = BigDecimal

The resulting type after applying the - operator.

§

fn neg(self) -> BigDecimal

Performs the unary - operation. Read more

§

fn from_str_radix( s: &str, radix: u32, ) -> Result<BigDecimal, ParseBigDecimalError>

Creates and initializes a BigDecimal.

§

type FromStrRadixErr = ParseBigDecimalError

§

impl One for BigDecimal

§

fn one() -> BigDecimal

§

fn array_type_info() -> PgTypeInfo

§

§

fn serialize<S>( &self, serializer: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>
where S: Serializer,

Serialize this value into the given Serde serializer. Read more

§

impl Signed for BigDecimal

§

fn abs(&self) -> BigDecimal

Computes the absolute value. Read more

§

fn abs_sub(&self, other: &BigDecimal) -> BigDecimal

The positive difference of two numbers. Read more

§

fn signum(&self) -> BigDecimal

Returns the additive identity element of Self, 0. Read more

§

fn is_zero(&self) -> bool

Returns true if self is equal to the additive identity.

Source §

fn set_zero(&mut self)

Sets self to the additive identity element of Self, 0.

§

impl Eq for BigDecimal

§

impl NotU8 for BigDecimal

fn binary<O, R>(self, op: O, right: R) -> SimpleExpr
where O: Into<BinOper>, R: Into<SimpleExpr>,

Create any binary operation Read more

§

fn cast_as<N>(self, type_name: N) -> SimpleExpr
where N: IntoIden,

Express a CAST AS expression. Read more

§

fn unary(self, op: UnOper) -> SimpleExpr

Apply any unary operator to the expression. Read more

§

fn add<R>(self, right: R) -> SimpleExpr
where R: Into<SimpleExpr>,

Express an arithmetic addition operation. Read more

§

§

fn from_value_tuple(i: I) -> V
where I: IntoValueTuple,

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more

§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. 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<V> IntoValueTuple for V
where V: Into<Value>,

§

The resulting type after obtaining ownership.

Source §

fn to_owned(&self) -> T

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

Performs the conversion.

§

impl<T> TryGetableMany for T
where T: TryGetable,

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more

§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more

Struct BigDecimal Copy item path

Fields§

Implementations§

impl BigDecimal

pub fn new(digits: BigInt, scale: i64) -> BigDecimal

pub fn from_bigint(digits: BigInt, scale: i64) -> BigDecimal

pub fn from_biguint(digits: BigUint, scale: i64) -> BigDecimal

pub fn to_ref(&self) -> BigDecimalRef<'_>

pub fn fractional_digit_count(&self) -> i64

§Examples

pub fn parse_bytes(buf: &[u8], radix: u32) -> Option<BigDecimal>

§Examples

pub fn with_scale(&self, new_scale: i64) -> BigDecimal

pub fn with_scale_round(&self, new_scale: i64, mode: RoundingMode) -> BigDecimal

pub fn with_prec(&self, prec: u64) -> BigDecimal

pub fn with_precision_round( &self, prec: NonZero<u64>, round: RoundingMode, ) -> BigDecimal

pub fn sign(&self) -> Sign

pub fn as_bigint_and_exponent(&self) -> (BigInt, i64)

§Examples

pub fn into_bigint_and_scale(self) -> (BigInt, i64)

pub fn as_bigint_and_scale(&self) -> (Cow<'_, BigInt>, i64)

pub fn into_bigint_and_exponent(self) -> (BigInt, i64)

§Examples

pub fn digits(&self) -> u64

pub fn abs(&self) -> BigDecimal

pub fn double(&self) -> BigDecimal

pub fn half(&self) -> BigDecimal

pub fn square(&self) -> BigDecimal

pub fn cube(&self) -> BigDecimal

pub fn sqrt(&self) -> Option<BigDecimal>

pub fn sqrt_with_context(&self, ctx: &Context) -> Option<BigDecimal>

pub fn cbrt(&self) -> BigDecimal

pub fn cbrt_with_context(&self, ctx: &Context) -> BigDecimal

pub fn inverse(&self) -> BigDecimal

pub fn inverse_with_context(&self, ctx: &Context) -> BigDecimal

pub fn round(&self, round_digits: i64) -> BigDecimal

pub fn is_integer(&self) -> bool

pub fn exp(&self) -> BigDecimal

pub fn normalized(&self) -> BigDecimal

pub fn to_plain_string(&self) -> String

§Panics

§Examples

pub fn write_plain_string<W>(&self, wtr: &mut W) -> Result<(), Error>where W: Write,

§Panics

pub fn to_scientific_notation(&self) -> String

pub fn write_scientific_notation<W>(&self, w: &mut W) -> Result<(), Error>where W: Write,

pub fn to_engineering_notation(&self) -> String

pub fn write_engineering_notation<W>(&self, w: &mut W) -> Result<(), Error>where W: Write,

Trait Implementations§

impl Add<&i128> for &BigDecimal

type Output = BigDecimal

fn add(self, rhs: &i128) -> BigDecimal

impl Add<&i128> for BigDecimal

type Output = BigDecimal

fn add(self, rhs: &i128) -> BigDecimal

impl Add<&i16> for &BigDecimal

type Output = BigDecimal

fn add(self, rhs: &i16) -> BigDecimal

impl Add<&i16> for BigDecimal

type Output = BigDecimal

fn add(self, rhs: &i16) -> BigDecimal

impl Add<&i32> for &BigDecimal

type Output = BigDecimal

fn add(self, rhs: &i32) -> BigDecimal

impl Add<&i32> for BigDecimal

type Output = BigDecimal

fn add(self, rhs: &i32) -> BigDecimal

impl Add<&i64> for &BigDecimal

type Output = BigDecimal

fn add(self, rhs: &i64) -> BigDecimal

impl Add<&i64> for BigDecimal

type Output = BigDecimal

fn add(self, rhs: &i64) -> BigDecimal

impl Add<&i8> for &BigDecimal

type Output = BigDecimal

fn add(self, rhs: &i8) -> BigDecimal

impl Add<&i8> for BigDecimal

type Output = BigDecimal

fn add(self, rhs: &i8) -> BigDecimal

impl Add<&u128> for &BigDecimal

Struct BigDecimal

pub fn write_plain_string<W>(&self, wtr: &mut W) -> Result<(), Error>
where W: Write,

pub fn write_scientific_notation<W>(&self, w: &mut W) -> Result<(), Error>
where W: Write,

pub fn write_engineering_notation<W>(&self, w: &mut W) -> Result<(), Error>
where W: Write,

impl<'a, T> Add<T> for &BigDecimal
where T: Into<BigDecimalRef<'a>>,

impl<'a, T> Add<T> for BigDecimal
where T: Into<BigDecimalRef<'a>>,