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
Implements
IMessage Decimal , IEquatable Decimal , IDeepCloneable Decimal , IBufferMessage , IMessageNamespace
Google.TypeAssembly
Google.Api.CommonProtos.dll
Constructors
Decimal()
public Decimal()
Decimal(Decimal)
public Decimal(Decimal other)
Fields
ValueFieldNumber
public
const
int
ValueFieldNumber
=
1
Field number for the "value" field.
Properties
Descriptor
public static MessageDescriptor Descriptor { get; }
Parser
public static MessageParser<Decimal> Parser { get; }
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 shouldnormalize 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 mayperform 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 maypreserve 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 notbe supported regardless of locale.
Additionally, thousand separators should notbe supported. If a
service does support them, values mustbe 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 shouldclearly 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 maychoose to accept values passed as input even when the
value has a higher precision or scale than the service supports, and shouldround the value to fit the supported scale. Alternatively, the
service mayerror with 400 Bad Request
( INVALID_ARGUMENT
in gRPC)
if precision would be lost.
Services shoulderror with 400 Bad Request
( INVALID_ARGUMENT
in
gRPC) if the service receives a value outside of the supported range.
Methods
CalculateSize()
public int CalculateSize()
Calculates the size of this message in Protocol Buffer wire format, in bytes.
The number of bytes required to write this message to a coded output stream.
Clone()
public Decimal Clone()
Creates a deep clone of this object.
Equals(Decimal)
public bool Equals(Decimal other)
Equals(object)
public override bool Equals(object other)
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.
GetHashCode()
public override int GetHashCode()
MergeFrom(CodedInputStream)
public void MergeFrom(CodedInputStream input)
Merges the data from the specified coded input stream with the current message.
See the user guide for precise merge semantics.
MergeFrom(Decimal)
public void MergeFrom(Decimal other)
Merges the given message into this one.
See the user guide for precise merge semantics.
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.
ToString()
public override string ToString()
WriteTo(CodedOutputStream)
public void WriteTo(CodedOutputStream output)
Writes the data to the given coded output stream.
output
