Trait tokio_postgres::types::ToSql

source ·

pub trait ToSql: Debug {
    // Required methods
    fn to_sql(
        &self,
        ty: &Type,
        out: &mut BytesMut,
    ) -> Result<IsNull, Box<dyn Error + Sync + Send>>
       where Self: Sized;
    fn accepts(ty: &Type) -> bool
       where Self: Sized;
    fn to_sql_checked(
        &self,
        ty: &Type,
        out: &mut BytesMut,
    ) -> Result<IsNull, Box<dyn Error + Sync + Send>>;

    // Provided method
    fn encode_format(&self, _ty: &Type) -> Format { ... }
}

Expand description

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
`&str`/`String`	VARCHAR, CHAR(n), TEXT, CITEXT, NAME
	LTREE, LQUERY, LTXTQUERY
`&[u8]`/`Vec<u8>`/`[u8; N]`	BYTEA
`HashMap<String, Option<String>>`	HSTORE
`SystemTime`	TIMESTAMP, TIMESTAMP WITH TIME ZONE
`IpAddr`	INET

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 prefixed by with-. For example, the with-serde_json-1 feature enables the implementation for the serde_json::Value type.

Rust type	Postgres type(s)
`chrono::NaiveDateTime`	TIMESTAMP
`chrono::DateTime<Utc>`	TIMESTAMP WITH TIME ZONE
`chrono::DateTime<Local>`	TIMESTAMP WITH TIME ZONE
`chrono::DateTime<FixedOffset>`	TIMESTAMP WITH TIME ZONE
`chrono::NaiveDate`	DATE
`chrono::NaiveTime`	TIME
`time::PrimitiveDateTime`	TIMESTAMP
`time::OffsetDateTime`	TIMESTAMP WITH TIME ZONE
`time::Date`	DATE
`time::Time`	TIME
`eui48::MacAddress`	MACADDR
`geo_types::Point<f64>`	POINT
`geo_types::Rect<f64>`	BOX
`geo_types::LineString<f64>`	PATH
`serde_json::Value`	JSON, JSONB
`uuid::Uuid`	UUID
`bit_vec::BitVec`	BIT, VARBIT
`eui48::MacAddress`	MACADDR

§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.

§Arrays

ToSql is implemented for [u8; N], Vec<T>, &[T], Box<[T]> and [T; N] where T implements ToSql and N is const usize, and corresponds to one-dimensional Postgres arrays with an index offset of 1.

Note: the impl for arrays only exist when the Cargo feature array-impls is enabled.

Required Methods§

source

fn to_sql( &self, ty: &Type, out: &mut BytesMut, ) -> Result<IsNull, Box<dyn Error + Sync + Send>>
where Self: Sized,

Converts the value of self into the binary format of the specified Postgres Type, appending 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.

source

fn accepts(ty: &Type) -> bool
where Self: Sized,

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

source

fn to_sql_checked( &self, ty: &Type, out: &mut BytesMut, ) -> Result<IsNull, Box<dyn Error + Sync + Send>>

An adaptor method used internally by Rust-Postgres.

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

Provided Methods§

source

fn encode_format(&self, _ty: &Type) -> Format

Specify the encode format

Trait tokio_postgres::types::ToSqlCopy item path

§Types

§Nullability

§Arrays

Required Methods§

fn to_sql( &self, ty: &Type, out: &mut BytesMut, ) -> Result<IsNull, Box<dyn Error + Sync + Send>>where Self: Sized,

fn accepts(ty: &Type) -> boolwhere Self: Sized,

fn to_sql_checked( &self, ty: &Type, out: &mut BytesMut, ) -> Result<IsNull, Box<dyn Error + Sync + Send>>

Provided Methods§

fn encode_format(&self, _ty: &Type) -> Format

Trait Implementations§

impl BorrowToSql for &dyn ToSql

fn borrow_to_sql(&self) -> &dyn ToSql

impl BorrowToSql for &(dyn ToSql + Sync)

fn borrow_to_sql(&self) -> &dyn ToSql

impl<'a> BorrowToSql for Box<dyn ToSql + Sync + Send + 'a>

fn borrow_to_sql(&self) -> &dyn ToSql

impl<'a> BorrowToSql for Box<dyn ToSql + Sync + 'a>

fn borrow_to_sql(&self) -> &dyn ToSql

Implementations on Foreign Types§

impl ToSql for IpAddr

fn to_sql( &self, _: &Type, w: &mut BytesMut, ) -> Result<IsNull, Box<dyn Error + Sync + Send>>

fn accepts(ty: &Type) -> bool

fn to_sql_checked( &self, ty: &Type, out: &mut BytesMut, ) -> Result<IsNull, Box<dyn Error + Sync + Send>>

impl ToSql for Value

fn to_sql( &self, ty: &Type, out: &mut BytesMut, ) -> Result<IsNull, Box<dyn Error + Sync + Send>>

fn accepts(ty: &Type) -> bool

fn to_sql_checked( &self, ty: &Type, out: &mut BytesMut, ) -> Result<IsNull, Box<dyn Error + Sync + Send>>

impl ToSql for bool

fn to_sql( &self, _: &Type, w: &mut BytesMut, ) -> Result<IsNull, Box<dyn Error + Sync + Send>>

fn accepts(ty: &Type) -> bool

fn to_sql_checked( &self, ty: &Type, out: &mut BytesMut, ) -> Result<IsNull, Box<dyn Error + Sync + Send>>

impl ToSql for f32

fn to_sql( &self, _: &Type, w: &mut BytesMut, ) -> Result<IsNull, Box<dyn Error + Sync + Send>>

fn accepts(ty: &Type) -> bool

fn to_sql_checked( &self, ty: &Type, out: &mut BytesMut, ) -> Result<IsNull, Box<dyn Error + Sync + Send>>

impl ToSql for f64

fn to_sql( &self, _: &Type, w: &mut BytesMut, ) -> Result<IsNull, Box<dyn Error + Sync + Send>>

fn accepts(ty: &Type) -> bool

fn to_sql_checked( &self, ty: &Type, out: &mut BytesMut, ) -> Result<IsNull, Box<dyn Error + Sync + Send>>

impl ToSql for i8

fn to_sql( &self, _: &Type, w: &mut BytesMut, ) -> Result<IsNull, Box<dyn Error + Sync + Send>>

fn accepts(ty: &Type) -> bool

fn to_sql_checked( &self, ty: &Type, out: &mut BytesMut, ) -> Result<IsNull, Box<dyn Error + Sync + Send>>

impl ToSql for i16

fn to_sql( &self, _: &Type, w: &mut BytesMut, ) -> Result<IsNull, Box<dyn Error + Sync + Send>>

fn accepts(ty: &Type) -> bool

fn to_sql_checked( &self, ty: &Type, out: &mut BytesMut, ) -> Result<IsNull, Box<dyn Error + Sync + Send>>

impl ToSql for i32

fn to_sql( &self, _: &Type, w: &mut BytesMut, ) -> Result<IsNull, Box<dyn Error + Sync + Send>>

fn accepts(ty: &Type) -> bool

fn to_sql_checked( &self, ty: &Type, out: &mut BytesMut, ) -> Result<IsNull, Box<dyn Error + Sync + Send>>

impl ToSql for i64

fn to_sql( &self, _: &Type, w: &mut BytesMut, ) -> Result<IsNull, Box<dyn Error + Sync + Send>>

fn accepts(ty: &Type) -> bool

fn to_sql_checked( &self, ty: &Type, out: &mut BytesMut, ) -> Result<IsNull, Box<dyn Error + Sync + Send>>

impl ToSql for u32

fn to_sql( &self, _: &Type, w: &mut BytesMut, ) -> Result<IsNull, Box<dyn Error + Sync + Send>>

fn accepts(ty: &Type) -> bool

fn to_sql_checked( &self, ty: &Type, out: &mut BytesMut, ) -> Result<IsNull, Box<dyn Error + Sync + Send>>

impl ToSql for Box<str>

fn to_sql( &self, ty: &Type, w: &mut BytesMut, ) -> Result<IsNull, Box<dyn Error + Sync + Send>>

fn accepts(ty: &Type) -> bool

fn to_sql_checked( &self, ty: &Type, out: &mut BytesMut, ) -> Result<IsNull, Box<dyn Error + Sync + Send>>

impl ToSql for String

fn to_sql( &self, ty: &Type, w: &mut BytesMut, ) -> Result<IsNull, Box<dyn Error + Sync + Send>>

fn accepts(ty: &Type) -> bool

fn to_sql_checked( &self, ty: &Type, out: &mut BytesMut, ) -> Result<IsNull, Box<dyn Error + Sync + Send>>

impl ToSql for Vec<u8>

fn to_sql( &self, ty: &Type, w: &mut BytesMut, ) -> Result<IsNull, Box<dyn Error + Sync + Send>>

fn accepts(ty: &Type) -> bool

fn to_sql_checked( &self, ty: &Type, out: &mut BytesMut, ) -> Result<IsNull, Box<dyn Error + Sync + Send>>

impl ToSql for SystemTime

fn to_sql( &self, _: &Type, w: &mut BytesMut, ) -> Result<IsNull, Box<dyn Error + Sync + Send>>

fn accepts(ty: &Type) -> bool

fn to_sql_checked( &self, ty: &Type, out: &mut BytesMut, ) -> Result<IsNull, Box<dyn Error + Sync + Send>>

impl ToSql for BitVec

fn to_sql( &self, _: &Type, out: &mut BytesMut, ) -> Result<IsNull, Box<dyn Error + Sync + Send>>

fn accepts(ty: &Type) -> bool

fn to_sql_checked( &self, ty: &Type, out: &mut BytesMut, ) -> Result<IsNull, Box<dyn Error + Sync + Send>>

Trait tokio_postgres::types::ToSql

fn to_sql( &self, ty: &Type, out: &mut BytesMut, ) -> Result<IsNull, Box<dyn Error + Sync + Send>>
where Self: Sized,

fn accepts(ty: &Type) -> bool
where Self: Sized,