Trait postgres::types::ToSql

pub trait ToSql: Debug {
    // Required methods
    fn to_sql<W>(
        &self,
        ty: &Type,
        out: &mut W,
        ctx: &SessionInfo<'_>,
    ) -> Result<IsNull>
       where Self: Sized,
             W: Write + ?Sized;
    fn accepts(ty: &Type) -> bool
       where Self: Sized;
    fn to_sql_checked(
        &self,
        ty: &Type,
        out: &mut dyn Write,
        ctx: &SessionInfo<'_>,
    ) -> Result<IsNull>;
}

A trait for types that can be converted into Postgres values.

Types

The following implementations are provided by this crate, along with the corresponding Postgres types:

Rust type	Postgres type(s)
bool	BOOL
i8	“char”
i16	SMALLINT, SMALLSERIAL
i32	INT, SERIAL
u32	OID
i64	BIGINT, BIGSERIAL
f32	REAL
f64	DOUBLE PRECISION
String	VARCHAR, CHAR(n), TEXT, CITEXT
&str	VARCHAR, CHAR(n), TEXT, CITEXT
Vec<u8>	BYTEA
&u8	BYTEA
HashMap<String, Option<String>>	HSTORE

In addition, some implementations are provided for types in third party crates. These are disabled by default; to opt into one of these implementations, activate the Cargo feature corresponding to the crate’s name. For example, the serde feature enables the implementation for the serde::json::Value type.

Rust type	Postgres type(s)
serialize::json::Json	JSON, JSONB
serde::json::Value	JSON, JSONB
time::Timespec	TIMESTAMP, TIMESTAMP WITH TIME ZONE
chrono::NaiveDateTime	TIMESTAMP
chrono::DateTime<UTC>	TIMESTAMP WITH TIME ZONE
chrono::NaiveDate	DATE
chrono::NaiveTime	TIME
uuid::Uuid	UUID

Nullability

In addition to the types listed above, ToSql is implemented for Option<T> where T implements ToSql. An Option<T> represents a nullable Postgres value.

Required Methods

fn to_sql<W>( &self, ty: &Type, out: &mut W, ctx: &SessionInfo<'_>, ) -> Result<IsNull>

where Self: Sized, W: Write + ?Sized,

Converts the value of self into the binary format of the specified Postgres Type, writing it to out.

The caller of this method is responsible for ensuring that this type is compatible with the Postgres Type.

The return value indicates if this value should be represented as NULL. If this is the case, implementations must not write anything to out.

fn accepts(ty: &Type) -> bool

where Self: Sized,

Determines if a value of this type can be converted to the specified Postgres Type.

fn to_sql_checked( &self, ty: &Type, out: &mut dyn Write, ctx: &SessionInfo<'_>, ) -> Result<IsNull>

An adaptor method used internally by Rust-Postgres.

All implementations of this method should be generated by the to_sql_checked!() macro.

Implementations on Foreign Types

impl ToSql for bool

fn to_sql_checked( &self, ty: &Type, out: &mut dyn Write, ctx: &SessionInfo<'_>, ) -> Result<IsNull>

fn to_sql<W: Write + ?Sized>( &self, _: &Type, w: &mut W, _: &SessionInfo<'_>, ) -> Result<IsNull>

fn accepts(ty: &Type) -> bool

impl ToSql for f32

fn to_sql_checked( &self, ty: &Type, out: &mut dyn Write, ctx: &SessionInfo<'_>, ) -> Result<IsNull>

fn to_sql<W: Write + ?Sized>( &self, _: &Type, w: &mut W, _: &SessionInfo<'_>, ) -> Result<IsNull>

fn accepts(ty: &Type) -> bool

impl ToSql for f64

fn to_sql_checked( &self, ty: &Type, out: &mut dyn Write, ctx: &SessionInfo<'_>, ) -> Result<IsNull>

fn to_sql<W: Write + ?Sized>( &self, _: &Type, w: &mut W, _: &SessionInfo<'_>, ) -> Result<IsNull>

fn accepts(ty: &Type) -> bool

impl ToSql for i8

fn to_sql_checked( &self, ty: &Type, out: &mut dyn Write, ctx: &SessionInfo<'_>, ) -> Result<IsNull>

fn to_sql<W: Write + ?Sized>( &self, _: &Type, w: &mut W, _: &SessionInfo<'_>, ) -> Result<IsNull>

fn accepts(ty: &Type) -> bool

impl ToSql for i16

fn to_sql_checked( &self, ty: &Type, out: &mut dyn Write, ctx: &SessionInfo<'_>, ) -> Result<IsNull>

fn to_sql<W: Write + ?Sized>( &self, _: &Type, w: &mut W, _: &SessionInfo<'_>, ) -> Result<IsNull>

fn accepts(ty: &Type) -> bool

impl ToSql for i32

fn to_sql_checked( &self, ty: &Type, out: &mut dyn Write, ctx: &SessionInfo<'_>, ) -> Result<IsNull>

fn to_sql<W: Write + ?Sized>( &self, _: &Type, w: &mut W, _: &SessionInfo<'_>, ) -> Result<IsNull>

fn accepts(ty: &Type) -> bool

impl ToSql for i64

fn to_sql_checked( &self, ty: &Type, out: &mut dyn Write, ctx: &SessionInfo<'_>, ) -> Result<IsNull>

fn to_sql<W: Write + ?Sized>( &self, _: &Type, w: &mut W, _: &SessionInfo<'_>, ) -> Result<IsNull>

fn accepts(ty: &Type) -> bool

impl ToSql for u32

fn to_sql_checked( &self, ty: &Type, out: &mut dyn Write, ctx: &SessionInfo<'_>, ) -> Result<IsNull>

fn to_sql<W: Write + ?Sized>( &self, _: &Type, w: &mut W, _: &SessionInfo<'_>, ) -> Result<IsNull>

fn accepts(ty: &Type) -> bool

impl ToSql for String

fn to_sql_checked( &self, ty: &Type, out: &mut dyn Write, ctx: &SessionInfo<'_>, ) -> Result<IsNull>

fn to_sql<W: Write + ?Sized>( &self, ty: &Type, w: &mut W, ctx: &SessionInfo<'_>, ) -> Result<IsNull>

fn accepts(ty: &Type) -> bool

impl ToSql for Vec<u8>

fn to_sql_checked( &self, ty: &Type, out: &mut dyn Write, ctx: &SessionInfo<'_>, ) -> Result<IsNull>

fn to_sql<W: Write + ?Sized>( &self, ty: &Type, w: &mut W, ctx: &SessionInfo<'_>, ) -> Result<IsNull>

fn accepts(ty: &Type) -> bool

impl ToSql for HashMap<String, Option<String>>

fn to_sql_checked( &self, ty: &Type, out: &mut dyn Write, ctx: &SessionInfo<'_>, ) -> Result<IsNull>

fn to_sql<W: Write + ?Sized>( &self, _: &Type, w: &mut W, _: &SessionInfo<'_>, ) -> Result<IsNull>

fn accepts(ty: &Type) -> bool

impl<'a> ToSql for &'a str

fn to_sql_checked( &self, ty: &Type, out: &mut dyn Write, ctx: &SessionInfo<'_>, ) -> Result<IsNull>

fn to_sql<W: Write + ?Sized>( &self, _: &Type, w: &mut W, _: &SessionInfo<'_>, ) -> Result<IsNull>

fn accepts(ty: &Type) -> bool

impl<'a> ToSql for &'a [u8]

fn to_sql_checked( &self, ty: &Type, out: &mut dyn Write, ctx: &SessionInfo<'_>, ) -> Result<IsNull>

fn to_sql<W: Write + ?Sized>( &self, _: &Type, w: &mut W, _: &SessionInfo<'_>, ) -> Result<IsNull>

fn accepts(ty: &Type) -> bool

impl<T: ToSql> ToSql for Option<T>

fn to_sql_checked( &self, ty: &Type, out: &mut dyn Write, ctx: &SessionInfo<'_>, ) -> Result<IsNull>

fn to_sql<W: Write + ?Sized>( &self, ty: &Type, out: &mut W, ctx: &SessionInfo<'_>, ) -> Result<IsNull>

fn accepts(ty: &Type) -> bool

Implementors

impl<'a, T: 'a + ToSql> ToSql for Slice<'a, T>