Enum mz_pgrepr::types::Type

pub enum Type {
    Array(Box<Type>),
    Bool,
    Bytea,
    Char,
    Date,
    Float4,
    Float8,
    Int2,
    Int4,
    Int8,
    UInt2,
    UInt4,
    UInt8,
    Interval {
        constraints: Option<IntervalConstraints>,
    },
    Json,
    Jsonb,
    List(Box<Type>),
    Map {
        value_type: Box<Type>,
    },
    Name,
    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,
    MzTimestamp,
    Range {
        element_type: Box<Type>,
    },
    MzAclItem,
    AclItem,
}

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.

UInt2

A 2-byte unsigned integer. This does not exist in PostgreSQL.

UInt4

A 4-byte unsigned integer. This does not exist in PostgreSQL.

UInt8

An 8-byte unsigned integer. This does not exist in PostgreSQL.

Interval

A time interval.

Fields

constraints: Option<IntervalConstraints>

Optional constraints on the type.

Json

A textual JSON blob.

Jsonb

A binary JSON blob.

List(Box<Type>)

A sequence of homogeneous values.

Map

A map with text keys and homogeneous values.

Fields

value_type: Box<Type>

The type of the values in the map.

Name

A character type for storing identifiers of no more than 64 bytes in length.

Numeric

An arbitrary precision number.

Fields

constraints: Option<NumericConstraints>

Optional constraints on the type.

Oid

An object identifier.

Record(Vec<Type>)

A sequence of heterogeneous values.

Text

A variable-length string.

BpChar

A (usually) fixed-length string.

Fields

length: Option<CharLength>

The length of the string.

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

VarChar

A variable-length string with an optional limit.

Fields

max_length: Option<CharLength>

An optional maximum length to enforce, in characters.

Time

A time of day without a day.

Fields

precision: Option<TimePrecision>

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

TimeTz

A time with a time zone.

Fields

precision: Option<TimePrecision>

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

Timestamp

A date and time, without a timezone.

Fields

precision: Option<TimestampPrecision>

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

TimestampTz

A date and time, with a timezone.

Fields

precision: Option<TimestampPrecision>

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

Uuid

A universally unique identifier.

RegProc

A function name.

RegType

A type name.

RegClass

A class name.

Int2Vector

A small int vector.

MzTimestamp

A Materialize timestamp.

Range

A range of values of the inner type.

Fields

element_type: Box<Type>

The domain type.

MzAclItem

A list of privileges granted to a user, that uses mz_repr::role_id::RoleIds for role references.

AclItem

A list of privileges granted to a user that uses mz_repr::adt::system::Oids for role references. This type is used primarily for compatibility with PostgreSQL.

Implementations

impl Type

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

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

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.

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

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

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

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

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

pub fn oid(&self) -> u32

Returns the OID of this type.

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

Returns the constraint on the type, if any.

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.

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.

Trait Implementations

impl Clone for Type

fn clone(&self) -> Type

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Type

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

Formats the value using the given formatter.

impl Display for Type

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

Formats the value using the given formatter.

impl From<&ScalarType> for Type

fn from(typ: &ScalarType) -> Type

Converts to this type from the input type.

impl PartialEq for Type

fn eq(&self, other: &Type) -> 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 TryFrom<&Type> for ScalarType

type Error = TypeConversionError

The type returned in the event of a conversion error.

fn try_from(typ: &Type) -> Result<ScalarType, TypeConversionError>

Performs the conversion.

impl Eq for Type

impl StructuralPartialEq for Type