Enum mz_pgrepr::types::Type

source · [−]

pub enum Type {
Show 30 variants
    Array(Box<Type>),
    Bool,
    Bytea,
    Char,
    Date,
    Float4,
    Float8,
    Int2,
    Int4,
    Int8,
    Interval {
        constraints: Option<IntervalConstraints>,
    },
    Json,
    Jsonb,
    List(Box<Type>),
    Map {
        value_type: Box<Type>,
    },
    Numeric {
        constraints: Option<NumericConstraints>,
    },
    Oid,
    Record(Vec<Type>),
    Text,
    BpChar {
        length: Option<CharLength>,
    },
    VarChar {
        max_length: Option<CharLength>,
    },
    Time {
        precision: Option<TimePrecision>,
    },
    TimeTz {
        precision: Option<TimePrecision>,
    },
    Timestamp {
        precision: Option<TimestampPrecision>,
    },
    TimestampTz {
        precision: Option<TimestampPrecision>,
    },
    Uuid,
    RegProc,
    RegType,
    RegClass,
    Int2Vector,
}

Expand description

The type of a Value.

The Display representation of a type is guaranteed to be valid PostgreSQL syntax that names the type and any modifiers.

Variants

`Array(Box<Type>)`

A variable-length multidimensional array of values.

`Bool`

A boolean value.

`Bytea`

A byte array, i.e., a variable-length binary string.

`Char`

A single-byte character.

`Date`

A date.

`Float4`

A 4-byte floating point number.

`Float8`

An 8-byte floating point number.

`Int2`

A 2-byte signed integer.

`Int4`

A 4-byte signed integer.

`Int8`

An 8-byte signed integer.

`Interval`

Fields

constraints: Option<IntervalConstraints>

Optional constraints on the type.

A time interval.

`Json`

A textual JSON blob.

`Jsonb`

A binary JSON blob.

`List(Box<Type>)`

A sequence of homogeneous values.

`Map`

Fields

value_type: Box<Type>

The type of the values in the map.

A map with text keys and homogeneous values.

`Numeric`

Fields

constraints: Option<NumericConstraints>

Optional constraints on the type.

An arbitrary precision number.

`Oid`

An object identifier.

`Record(Vec<Type>)`

A sequence of heterogeneous values.

`Text`

A variable-length string.

`BpChar`

Fields

length: Option<CharLength>

The length of the string.

If unspecified, the type represents a variable-length string.

A (usually) fixed-length string.

`VarChar`

Fields

max_length: Option<CharLength>

An optional maximum length to enforce, in characters.

A variable-length string with an optional limit.

`Time`

Fields

precision: Option<TimePrecision>

An optional precision for the fractional digits in the second field.

A time of day without a day.

`TimeTz`

Fields

precision: Option<TimePrecision>

An optional precision for the fractional digits in the second field.

A time with a time zone.

`Timestamp`

Fields

precision: Option<TimestampPrecision>

An optional precision for the fractional digits in the second field.

A date and time, without a timezone.

`TimestampTz`

Fields

precision: Option<TimestampPrecision>

An optional precision for the fractional digits in the second field.

A date and time, with a timezone.

`Uuid`

A universally unique identifier.

`RegProc`

A function name.

`RegType`

A type name.

`RegClass`

A class name.

`Int2Vector`

A small int vector.

Implementations

source

impl Type

source

pub fn from_oid(oid: u32) -> Result<Type, TypeFromOidError>

Returns the type corresponding to the provided OID, if the OID is known.

source

pub fn from_oid_and_typmod(
oid: u32,
typmod: i32
) -> Result<Type, TypeFromOidError>

Returns the Type corresponding to the provided OID and packed type modifier (“typmod”).

For details about typmods, see the typmod method.

Errors

Returns an error if the OID is unknown or if the typmod is invalid for the type.

source

pub(crate) fn inner(&self) -> &'static Type

source

pub fn catalog_name(&self) -> &'static str

Returns the item’s name in a way that guarantees it’s resolvable in the catalog.

source

pub fn name(&self) -> &'static str

Returns the user-friendly name that PostgreSQL uses for this type.

source

pub fn oid(&self) -> u32

Returns the OID of this type.

source

pub fn constraint(&self) -> Option<&dyn TypeConstraint>

Returns the constraint on the type, if any.

source

pub fn typlen(&self) -> i16

Returns the number of bytes in the binary representation of this type, or -1 if the type has a variable-length representation.

source

pub fn typmod(&self) -> i32

Returns the packed type modifier (“typmod”) for the type.

The typmod is a 32-bit integer associated with the type that encodes optional constraints on the type. For example, the typmod on Type::VarChar encodes an optional constraint on the value’s length. Most types are never associated with a typmod.

Negative typmods indicate no constraint.