Class Decimal (2.10.0)

public sealed class Decimal : IMessage<Decimal>, IEquatable<Decimal>, IDeepCloneable<Decimal>, IBufferMessage, IMessage

A representation of a decimal value, such as 2.5. Clients may convert values into language-native decimal formats, such as Java's [BigDecimal][] or Python's decimal.Decimal.

[BigDecimal]: https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/math/BigDecimal.html

Inheritance

object > Decimal

Implements

IMessage Decimal, IEquatable Decimal, IDeepCloneable Decimal, IBufferMessage, IMessage

Inherited Members

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetType()

Namespace

Google.Type

Assembly

Google.Api.CommonProtos.dll

Constructors

Decimal()

public Decimal()

Decimal(Decimal)

public Decimal(Decimal other)

Parameter
Name	Description
`other`	`Decimal`

Fields

ValueFieldNumber

public const int ValueFieldNumber = 1

Field number for the "value" field.

Field Value
Type	Description
`int`

Properties

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value
Type	Description
`MessageDescriptor`

Parser

public static MessageParser<Decimal> Parser { get; }

Property Value
Type	Description
`MessageParserDecimal`

Value

public string Value { get; set; }

The decimal value, as a string.

The string representation consists of an optional sign, + (U+002B) or - (U+002D), followed by a sequence of zero or more decimal digits ("the integer"), optionally followed by a fraction, optionally followed by an exponent.

The fraction consists of a decimal point followed by zero or more decimal digits. The string must contain at least one digit in either the integer or the fraction. The number formed by the sign, the integer and the fraction is referred to as the significand.

The exponent consists of the character e (U+0065) or E (U+0045) followed by one or more decimal digits.

Services should normalize decimal values before storing them by:

Removing an explicitly-provided + sign (+2.5 -> 2.5).
Replacing a zero-length integer value with 0 (.5 -> 0.5).
Coercing the exponent character to lower-case (2.5E8 -> 2.5e8).
Removing an explicitly-provided zero exponent (2.5e0 -> 2.5).

Services may perform additional normalization based on its own needs and the internal decimal implementation selected, such as shifting the decimal point and exponent value together (example: 2.5e-1 <-> 0.25). Additionally, services may preserve trailing zeroes in the fraction to indicate increased precision, but are not required to do so.

Note that only the . character is supported to divide the integer and the fraction; , should not be supported regardless of locale. Additionally, thousand separators should not be supported. If a service does support them, values must be normalized.

The ENBF grammar is:

DecimalString =
  [Sign] Significand [Exponent];

Sign = '+' | '-';

Significand =
  Digits ['.'] [Digits] | [Digits] '.' Digits;

Exponent = ('e' | 'E') [Sign] Digits;

Digits = { '0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9' };

Services should clearly document the range of supported values, the maximum supported precision (total number of digits), and, if applicable, the scale (number of digits after the decimal point), as well as how it behaves when receiving out-of-bounds values.

Services may choose to accept values passed as input even when the value has a higher precision or scale than the service supports, and should round the value to fit the supported scale. Alternatively, the service may error with 400 Bad Request (INVALID_ARGUMENT in gRPC) if precision would be lost.

Services should error with 400 Bad Request (INVALID_ARGUMENT in gRPC) if the service receives a value outside of the supported range.

Property Value
Type	Description
`string`

Methods

CalculateSize()

public int CalculateSize()

Returns
Type	Description
`int`

Clone()

public Decimal Clone()

Returns
Type	Description
`Decimal`

Equals(Decimal)

public bool Equals(Decimal other)

Parameter
Name	Description
`other`	`Decimal`

Returns
Type	Description
`bool`

Equals(object)

public override bool Equals(object other)

Parameter
Name	Description
`other`	`object`

Returns
Type	Description
`bool`

Overrides

object.Equals(object)

FromClrDecimal(decimal)

public static Decimal FromClrDecimal(decimal value)

Converts the given decimal value to the protobuf Decimal representation. If the input value naturally contains trailing decimal zeroes (e.g. "1.00") these are preserved in the protobuf representation.

Parameter
Name	Description
`value`	`decimal` The value to convert.

Returns
Type	Description
`Decimal`	The protobuf representation.

GetHashCode()

public override int GetHashCode()

Returns
Type	Description
`int`

Overrides

object.GetHashCode()

MergeFrom(CodedInputStream)

public void MergeFrom(CodedInputStream input)

Parameter
Name	Description
`input`	`CodedInputStream`

MergeFrom(Decimal)

public void MergeFrom(Decimal other)

Parameter
Name	Description
`other`	`Decimal`

ToClrDecimal()

public decimal ToClrDecimal()

Converts this protobuf Decimal value to a CLR decimal value. If the value is within the range of decimal but contains more than 29 significant digits, the returned value is truncated towards zero.

Returns
Type	Description
`decimal`	The CLR representation of this value.

Exceptions
Type	Description
`FormatException`	This protobuf value is invalid, either because Value has not been set, or because it does not represent a valid decimal value.
`OverflowException`	The protobuf value is too large or small to be represented by decimal.

ToString()

public override string ToString()

Returns
Type	Description
`string`

Overrides

object.ToString()

WriteTo(CodedOutputStream)

public void WriteTo(CodedOutputStream output)

Parameter
Name	Description
`output`	`CodedOutputStream`