Enum TypeCode 

#[non_exhaustive]
pub enum TypeCode {
    Unspecified,
    Bool,
    Int64,
    Float64,
    Float32,
    Timestamp,
    Date,
    String,
    Bytes,
    Array,
    Struct,
    Numeric,
    Json,
    Proto,
    Enum,
    Interval,
    Uuid,
    UnknownValue(UnknownValue),
}

TypeCode is used as part of Type to indicate the type of a Cloud Spanner value.

Each legal value of a type can be encoded to or decoded from a JSON value, using the encodings described below. All Cloud Spanner values can be null, regardless of type; nulls are always encoded as a JSON null.

Working with unknown values

This enum is defined as #[non_exhaustive] because Google Cloud may add additional enum variants at any time. Adding new variants is not considered a breaking change. Applications should write their code in anticipation of:

• New values appearing in future releases of the client library, and
• New values received dynamically, without application changes.

Please consult the Working with enums section in the user guide for some guidelines.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Unspecified

Not specified.

Bool

Encoded as JSON true or false.

Int64

Encoded as string, in decimal format.

Float64

Encoded as number, or the strings "NaN", "Infinity", or "-Infinity".

Float32

Encoded as number, or the strings "NaN", "Infinity", or "-Infinity".

Timestamp

Encoded as string in RFC 3339 timestamp format. The time zone must be present, and must be "Z".

If the schema has the column option allow_commit_timestamp=true, the placeholder string "spanner.commit_timestamp()" can be used to instruct the system to insert the commit timestamp associated with the transaction commit.

Date

Encoded as string in RFC 3339 date format.

String

Encoded as string.

Bytes

Encoded as a base64-encoded string, as described in RFC 4648, section 4.

Array

Encoded as list, where the list elements are represented according to array_element_type.

Struct

Encoded as list, where list element i is represented according to struct_type.fields[i].

Numeric

Encoded as string, in decimal format or scientific notation format. Decimal format: [+-]Digits[.[Digits]] or [+-][Digits].Digits

Scientific notation: [+-]Digits[.[Digits]][ExponentIndicator[+-]Digits] or [+-][Digits].Digits[ExponentIndicator[+-]Digits] (ExponentIndicator is "e" or "E")

Json

Encoded as a JSON-formatted string as described in RFC 7159. The following rules are applied when parsing JSON input:

• Whitespace characters are not preserved.
• If a JSON object has duplicate keys, only the first key is preserved.
• Members of a JSON object are not guaranteed to have their order preserved.
• JSON array elements will have their order preserved.

Proto

Encoded as a base64-encoded string, as described in RFC 4648, section 4.

Enum

Encoded as string, in decimal format.

Interval

Encoded as string, in ISO8601 duration format - P[n]Y[n]M[n]DT[n]H[n]M[n[.fraction]]S where n is an integer. For example, P1Y2M3DT4H5M6.5S represents time duration of 1 year, 2 months, 3 days, 4 hours, 5 minutes, and 6.5 seconds.

Uuid

Encoded as string, in lower-case hexa-decimal format, as described in RFC 9562, section 4.

UnknownValue(UnknownValue)

If set, the enum was initialized with an unknown value.

Applications can examine the value using TypeCode::value or TypeCode::name.

Implementations

impl TypeCode

pub fn value(&self) -> Option<i32>

Gets the enum value.

Returns None if the enum contains an unknown value deserialized from the string representation of enums.

pub fn name(&self) -> Option<&str>

Gets the enum value as a string.

Returns None if the enum contains an unknown value deserialized from the integer representation of enums.

Trait Implementations

impl Clone for TypeCode

fn clone(&self) -> TypeCode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TypeCode

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

Formats the value using the given formatter.

impl Default for TypeCode

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for TypeCode

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for TypeCode

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

Formats the value using the given formatter.

impl From<&str> for TypeCode

fn from(value: &str) -> Self

Converts to this type from the input type.

impl From<TypeCode> for TypeCode

fn from(value: TypeCode) -> Self

Converts to this type from the input type.

impl From<TypeCode> for TypeCode

fn from(value: TypeCode) -> Self

Converts to this type from the input type.

impl From<i32> for TypeCode

fn from(value: i32) -> Self

Converts to this type from the input type.

impl PartialEq for TypeCode

fn eq(&self, other: &TypeCode) -> 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 Serialize for TypeCode

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for TypeCode