Struct PgTypeInfo

pub struct PgTypeInfo(/* private fields */);

Available on crate feature postgres only.

Type information for a PostgreSQL type.

Implementations

impl PgTypeInfo

pub fn kind(&self) -> &PgTypeKind

Returns the kind (simple, array, enum, etc.) for this type.

pub fn oid(&self) -> Option<Oid>

Returns the OID for this type, if available.

The OID may not be available if SQLx only knows the type by name. It will have to be resolved by a PgConnection at runtime which will yield a new and semantically distinct TypeInfo instance.

This method does not perform any such lookup.

Note

With the exception of the default pg_type catalog, type OIDs are not stable in PostgreSQL. If a type is added by an extension, its OID will be assigned when the CREATE EXTENSION statement is executed, and so can change depending on what extensions are installed and in what order, as well as the exact version of PostgreSQL.

pub const fn with_name(name: &'static str) -> PgTypeInfo

Create a PgTypeInfo from a type name.

The OID for the type will be fetched from Postgres on use of a value of this type. The fetched OID will be cached per-connection.

pub const fn with_oid(oid: Oid) -> PgTypeInfo

Create a PgTypeInfo from an OID.

Note that the OID for a type is very dependent on the environment. If you only ever use one database or if this is an unhandled built-in type, you should be fine. Otherwise, you will be better served using with_name.

Trait Implementations

impl Clone for PgTypeInfo

fn clone(&self) -> PgTypeInfo

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PgTypeInfo

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

Formats the value using the given formatter.

impl Deref for PgTypeInfo

type Target = PgType

The resulting type after dereferencing.

fn deref(&self) -> &<PgTypeInfo as Deref>::Target

Dereferences the value.

impl Display for PgTypeInfo

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

Formats the value using the given formatter.

impl PartialEq for PgTypeInfo

fn eq(&self, other: &PgTypeInfo) -> 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<'a> TryFrom<&'a PgTypeInfo> for AnyTypeInfo

type Error = Error

The type returned in the event of a conversion error.

fn try_from( pg_type: &'a PgTypeInfo, ) -> Result<AnyTypeInfo, <AnyTypeInfo as TryFrom<&'a PgTypeInfo>>::Error>

Performs the conversion.

impl TypeInfo for PgTypeInfo

fn name(&self) -> &str

Returns the database system name of the type. Length specifiers should not be included. Common type names are VARCHAR, TEXT, or INT. Type names should be uppercase. They should be a rough approximation of how they are written in SQL in the given database.

fn is_null(&self) -> bool

impl StructuralPartialEq for PgTypeInfo