Trait postgres_types::ToSql

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

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
&[u8]/Vec<u8>	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 Vec<T> and &[T] where T implements ToSql, and corresponds to one-dimensional Postgres arrays with an index offset of 1.

Required methods

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

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

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

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

Loading content...

Trait Implementations

impl<'_> BorrowToSql for &'_ dyn ToSql

pub fn borrow_to_sql(&self) -> &dyn ToSql

Returns a reference to self as a ToSql trait object.

Implementations on Foreign Types

impl<'a, T> ToSql for &'a T where
    T: ToSql, 

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

pub fn accepts(ty: &Type) -> bool

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

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

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

pub fn accepts(ty: &Type) -> bool

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

impl<'a, T: ToSql> ToSql for &'a [T]

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

pub fn accepts(ty: &Type) -> bool

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

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

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

pub fn accepts(ty: &Type) -> bool

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

impl<T: ToSql> ToSql for Vec<T>

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

pub fn accepts(ty: &Type) -> bool

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

impl ToSql for Vec<u8>

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

pub fn accepts(ty: &Type) -> bool

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

impl<'a> ToSql for &'a str

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

pub fn accepts(ty: &Type) -> bool

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

impl<'a> ToSql for Cow<'a, str>

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

pub fn accepts(ty: &Type) -> bool

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

impl ToSql for String

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

pub fn accepts(ty: &Type) -> bool

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

impl ToSql for bool

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

pub fn accepts(ty: &Type) -> bool

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

impl ToSql for i8

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

pub fn accepts(ty: &Type) -> bool

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

impl ToSql for i16

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

pub fn accepts(ty: &Type) -> bool

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

impl ToSql for i32

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

pub fn accepts(ty: &Type) -> bool

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

impl ToSql for u32

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

pub fn accepts(ty: &Type) -> bool

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

impl ToSql for i64

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

pub fn accepts(ty: &Type) -> bool

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

impl ToSql for f32

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

pub fn accepts(ty: &Type) -> bool

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

impl ToSql for f64

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

pub fn accepts(ty: &Type) -> bool

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

impl<H> ToSql for HashMap<String, Option<String>, H> where
    H: BuildHasher, 

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

pub fn accepts(ty: &Type) -> bool

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

impl ToSql for SystemTime

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

pub fn accepts(ty: &Type) -> bool

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

impl ToSql for IpAddr

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

pub fn accepts(ty: &Type) -> bool

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

Loading content...

Implementors

impl<T: ToSql> ToSql for Date<T>

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

pub fn accepts(ty: &Type) -> bool

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

impl<T: ToSql> ToSql for Timestamp<T>

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

pub fn accepts(ty: &Type) -> bool

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

Loading content...