Trait diesel::serialize::ToSql

pub trait ToSql<A, DB: Backend>: Debug {
    fn to_sql<W: Write>(&self, out: &mut Output<W, DB>) -> Result;
}

Serializes a single value to be sent to the database.

The output is sent as a bind parameter, and the data must be written in the expected format for the given backend.

When possible, implementations of this trait should prefer using an existing implementation, rather than writing to out directly. (For example, if you are implementing this for an enum, which is represented as an integer in the database, you should use i32::to_sql(x, out) instead of writing to out yourself.

Any types which implement this trait should also #[derive(AsExpression)].

Backend specific details

• For PostgreSQL, the bytes will be sent using the binary protocol, not text.
• For SQLite, all implementations should be written in terms of an existing ToSql implementation.
• For MySQL, the expected bytes will depend on the return value of type_metadata for the given SQL type. See MysqlType for details.
• For third party backends, consult that backend's documentation.

Examples

Most implementations of this trait will be defined in terms of an existing implementation.

#[repr(i32)]
#[derive(Debug, Clone, Copy)]
pub enum MyEnum {
    A = 1,
    B = 2,
}

impl<DB> ToSql<Integer, DB> for MyEnum
where
    DB: Backend,
    i32: ToSql<Integer, DB>,
{
    fn to_sql<W: Write>(&self, out: &mut Output<W, DB>) -> serialize::Result {
        (*self as i32).to_sql(out)
    }
}

Required methods

fn to_sql<W: Write>(&self, out: &mut Output<W, DB>) -> Result

See the trait documentation.

Loading content...

Implementations on Foreign Types

impl<'a, A, T: ?Sized, DB> ToSql<A, DB> for &'a T where
    DB: Backend,
    T: ToSql<A, DB>, 

fn to_sql<W: Write>(&self, out: &mut Output<W, DB>) -> Result

impl ToSql<Datetime, Mysql> for MYSQL_TIME

fn to_sql<W: Write>(&self, out: &mut Output<W, Mysql>) -> Result

impl ToSql<Timestamp, Mysql> for MYSQL_TIME

fn to_sql<W: Write>(&self, out: &mut Output<W, Mysql>) -> Result

impl ToSql<Time, Mysql> for MYSQL_TIME

fn to_sql<W: Write>(&self, out: &mut Output<W, Mysql>) -> Result

impl ToSql<Date, Mysql> for MYSQL_TIME

fn to_sql<W: Write>(&self, out: &mut Output<W, Mysql>) -> Result

impl ToSql<Datetime, Mysql> for NaiveDateTime

fn to_sql<W: Write>(&self, out: &mut Output<W, Mysql>) -> Result

impl ToSql<Timestamp, Mysql> for NaiveDateTime

fn to_sql<W: Write>(&self, out: &mut Output<W, Mysql>) -> Result

impl ToSql<Time, Mysql> for NaiveTime

fn to_sql<W: Write>(&self, out: &mut Output<W, Mysql>) -> Result

impl ToSql<Date, Mysql> for NaiveDate

fn to_sql<W: Write>(&self, out: &mut Output<W, Mysql>) -> Result

impl ToSql<Numeric, Mysql> for BigDecimal

fn to_sql<W: Write>(&self, out: &mut Output<W, Mysql>) -> Result

impl ToSql<TinyInt, Mysql> for i8

fn to_sql<W: Write>(&self, out: &mut Output<W, Mysql>) -> Result

impl ToSql<Unsigned<TinyInt>, Mysql> for u8

fn to_sql<W: Write>(&self, out: &mut Output<W, Mysql>) -> Result

impl ToSql<Unsigned<SmallInt>, Mysql> for u16

fn to_sql<W: Write>(&self, out: &mut Output<W, Mysql>) -> Result

impl ToSql<Unsigned<Integer>, Mysql> for u32

fn to_sql<W: Write>(&self, out: &mut Output<W, Mysql>) -> Result

impl ToSql<Unsigned<BigInt>, Mysql> for u64

fn to_sql<W: Write>(&self, out: &mut Output<W, Mysql>) -> Result

impl ToSql<Bool, Mysql> for bool

fn to_sql<W: Write>(&self, out: &mut Output<W, Mysql>) -> Result

impl<ST, T> ToSql<Array<ST>, Pg> for [T] where
    Pg: HasSqlType<ST>,
    T: ToSql<ST, Pg>, 

fn to_sql<W: Write>(&self, out: &mut Output<W, Pg>) -> Result

impl<ST, T> ToSql<Nullable<Array<ST>>, Pg> for [T] where
    [T]: ToSql<Array<ST>, Pg>, 

fn to_sql<W: Write>(&self, out: &mut Output<W, Pg>) -> Result

impl<ST, T> ToSql<Array<ST>, Pg> for Vec<T> where
    [T]: ToSql<Array<ST>, Pg>,
    T: Debug, 

fn to_sql<W: Write>(&self, out: &mut Output<W, Pg>) -> Result

impl<ST, T> ToSql<Nullable<Array<ST>>, Pg> for Vec<T> where
    Vec<T>: ToSql<Array<ST>, Pg>, 

fn to_sql<W: Write>(&self, out: &mut Output<W, Pg>) -> Result

impl ToSql<Timestamp, Pg> for NaiveDateTime

fn to_sql<W: Write>(&self, out: &mut Output<W, Pg>) -> Result

impl ToSql<Timestamptz, Pg> for NaiveDateTime

fn to_sql<W: Write>(&self, out: &mut Output<W, Pg>) -> Result

impl<TZ: TimeZone> ToSql<Timestamptz, Pg> for DateTime<TZ>

fn to_sql<W: Write>(&self, out: &mut Output<W, Pg>) -> Result

impl ToSql<Time, Pg> for NaiveTime

fn to_sql<W: Write>(&self, out: &mut Output<W, Pg>) -> Result

impl ToSql<Date, Pg> for NaiveDate

fn to_sql<W: Write>(&self, out: &mut Output<W, Pg>) -> Result

impl<__DB> ToSql<Nullable<Timestamp>, __DB> for Timespec where
    __DB: Backend,
    Self: ToSql<Timestamp, __DB>, 

fn to_sql<W: Write>(&self, out: &mut Output<W, __DB>) -> Result

impl ToSql<Timestamp, Pg> for Timespec

fn to_sql<W: Write>(&self, out: &mut Output<W, Pg>) -> Result

impl ToSql<Timestamp, Pg> for SystemTime

fn to_sql<W: Write>(&self, out: &mut Output<W, Pg>) -> Result

impl ToSql<Oid, Pg> for u32

fn to_sql<W: Write>(&self, out: &mut Output<W, Pg>) -> Result

impl<__DB> ToSql<Nullable<Json>, __DB> for Value where
    __DB: Backend,
    Self: ToSql<Json, __DB>, 

fn to_sql<W: Write>(&self, out: &mut Output<W, __DB>) -> Result

impl<__DB> ToSql<Nullable<Jsonb>, __DB> for Value where
    __DB: Backend,
    Self: ToSql<Jsonb, __DB>, 

fn to_sql<W: Write>(&self, out: &mut Output<W, __DB>) -> Result

impl ToSql<Json, Pg> for Value

fn to_sql<W: Write>(&self, out: &mut Output<W, Pg>) -> Result

impl ToSql<Jsonb, Pg> for Value

fn to_sql<W: Write>(&self, out: &mut Output<W, Pg>) -> Result

impl<__DB> ToSql<Nullable<MacAddr>, __DB> for [u8; 6] where
    __DB: Backend,
    Self: ToSql<MacAddr, __DB>, 

fn to_sql<W: Write>(&self, out: &mut Output<W, __DB>) -> Result

impl<__DB> ToSql<Nullable<Inet>, __DB> for IpNetwork where
    __DB: Backend,
    Self: ToSql<Inet, __DB>, 

fn to_sql<W: Write>(&self, out: &mut Output<W, __DB>) -> Result

impl<__DB> ToSql<Nullable<Cidr>, __DB> for IpNetwork where
    __DB: Backend,
    Self: ToSql<Cidr, __DB>, 

fn to_sql<W: Write>(&self, out: &mut Output<W, __DB>) -> Result

impl ToSql<MacAddr, Pg> for [u8; 6]

fn to_sql<W: Write>(&self, out: &mut Output<W, Pg>) -> Result

impl ToSql<Inet, Pg> for IpNetwork

fn to_sql<W: Write>(&self, out: &mut Output<W, Pg>) -> Result

impl ToSql<Cidr, Pg> for IpNetwork

fn to_sql<W: Write>(&self, out: &mut Output<W, Pg>) -> Result

impl ToSql<Numeric, Pg> for BigDecimal

fn to_sql<W: Write>(&self, out: &mut Output<W, Pg>) -> Result

impl ToSql<Bool, Pg> for bool

fn to_sql<W: Write>(&self, out: &mut Output<W, Pg>) -> Result

impl<ST, T> ToSql<Range<ST>, Pg> for (Bound<T>, Bound<T>) where
    T: ToSql<ST, Pg>, 

fn to_sql<W: Write>(&self, out: &mut Output<W, Pg>) -> Result

impl<ST, T> ToSql<Nullable<Range<ST>>, Pg> for (Bound<T>, Bound<T>) where
    (Bound<T>, Bound<T>): ToSql<Range<ST>, Pg>, 

fn to_sql<W: Write>(&self, out: &mut Output<W, Pg>) -> Result

impl<__DB> ToSql<Nullable<Uuid>, __DB> for Uuid where
    __DB: Backend,
    Self: ToSql<Uuid, __DB>, 

fn to_sql<W: Write>(&self, out: &mut Output<W, __DB>) -> Result

impl ToSql<Uuid, Pg> for Uuid

fn to_sql<W: Write>(&self, out: &mut Output<W, Pg>) -> Result

impl ToSql<Date, Sqlite> for NaiveDate

fn to_sql<W: Write>(&self, out: &mut Output<W, Sqlite>) -> Result

impl ToSql<Time, Sqlite> for NaiveTime

fn to_sql<W: Write>(&self, out: &mut Output<W, Sqlite>) -> Result

impl ToSql<Timestamp, Sqlite> for NaiveDateTime

fn to_sql<W: Write>(&self, out: &mut Output<W, Sqlite>) -> Result

impl ToSql<Date, Sqlite> for str

fn to_sql<W: Write>(&self, out: &mut Output<W, Sqlite>) -> Result

impl ToSql<Date, Sqlite> for String

fn to_sql<W: Write>(&self, out: &mut Output<W, Sqlite>) -> Result

impl ToSql<Time, Sqlite> for str

fn to_sql<W: Write>(&self, out: &mut Output<W, Sqlite>) -> Result

impl ToSql<Time, Sqlite> for String

fn to_sql<W: Write>(&self, out: &mut Output<W, Sqlite>) -> Result

impl ToSql<Timestamp, Sqlite> for str

fn to_sql<W: Write>(&self, out: &mut Output<W, Sqlite>) -> Result

impl ToSql<Timestamp, Sqlite> for String

fn to_sql<W: Write>(&self, out: &mut Output<W, Sqlite>) -> Result

impl ToSql<Bool, Sqlite> for bool

fn to_sql<W: Write>(&self, out: &mut Output<W, Sqlite>) -> Result

impl<__DB> ToSql<Nullable<Timestamp>, __DB> for SystemTime where
    __DB: Backend,
    Self: ToSql<Timestamp, __DB>, 

fn to_sql<W: Write>(&self, out: &mut Output<W, __DB>) -> Result

impl<__DB> ToSql<Nullable<Date>, __DB> for NaiveDate where
    __DB: Backend,
    Self: ToSql<Date, __DB>, 

fn to_sql<W: Write>(&self, out: &mut Output<W, __DB>) -> Result

impl<__DB> ToSql<Nullable<Time>, __DB> for NaiveTime where
    __DB: Backend,
    Self: ToSql<Time, __DB>, 

fn to_sql<W: Write>(&self, out: &mut Output<W, __DB>) -> Result

impl<__DB> ToSql<Nullable<Timestamp>, __DB> for NaiveDateTime where
    __DB: Backend,
    Self: ToSql<Timestamp, __DB>, 

fn to_sql<W: Write>(&self, out: &mut Output<W, __DB>) -> Result

impl<__DB> ToSql<Nullable<Timestamptz>, __DB> for NaiveDateTime where
    __DB: Backend,
    Self: ToSql<Timestamptz, __DB>, 

fn to_sql<W: Write>(&self, out: &mut Output<W, __DB>) -> Result

impl<__DB> ToSql<Nullable<Datetime>, __DB> for NaiveDateTime where
    __DB: Backend,
    Self: ToSql<Datetime, __DB>, 

fn to_sql<W: Write>(&self, out: &mut Output<W, __DB>) -> Result

impl<Tz: TimeZone, __DB> ToSql<Nullable<Timestamptz>, __DB> for DateTime<Tz> where
    __DB: Backend,
    Self: ToSql<Timestamptz, __DB>, 

fn to_sql<W: Write>(&self, out: &mut Output<W, __DB>) -> Result

impl<__DB> ToSql<Nullable<Numeric>, __DB> for BigDecimal where
    __DB: Backend,
    Self: ToSql<Numeric, __DB>, 

fn to_sql<W: Write>(&self, out: &mut Output<W, __DB>) -> Result

impl<DB: Backend> ToSql<Float, DB> for f32

fn to_sql<W: Write>(&self, out: &mut Output<W, DB>) -> Result

impl<DB: Backend> ToSql<Double, DB> for f64

fn to_sql<W: Write>(&self, out: &mut Output<W, DB>) -> Result

impl<DB: Backend> ToSql<SmallInt, DB> for i16

fn to_sql<W: Write>(&self, out: &mut Output<W, DB>) -> Result

impl<DB: Backend> ToSql<Integer, DB> for i32

fn to_sql<W: Write>(&self, out: &mut Output<W, DB>) -> Result

impl<DB: Backend> ToSql<BigInt, DB> for i64

fn to_sql<W: Write>(&self, out: &mut Output<W, DB>) -> Result

impl<T, ST, DB> ToSql<Nullable<ST>, DB> for Option<T> where
    T: ToSql<ST, DB>,
    DB: Backend,
    ST: NotNull, 

fn to_sql<W: Write>(&self, out: &mut Output<W, DB>) -> Result

impl<__DB> ToSql<Nullable<Bool>, __DB> for bool where
    __DB: Backend,
    Self: ToSql<Bool, __DB>, 

fn to_sql<W: Write>(&self, out: &mut Output<W, __DB>) -> Result

impl<__DB> ToSql<Nullable<TinyInt>, __DB> for i8 where
    __DB: Backend,
    Self: ToSql<TinyInt, __DB>, 

fn to_sql<W: Write>(&self, out: &mut Output<W, __DB>) -> Result

impl<__DB> ToSql<Nullable<SmallInt>, __DB> for i16 where
    __DB: Backend,
    Self: ToSql<SmallInt, __DB>, 

fn to_sql<W: Write>(&self, out: &mut Output<W, __DB>) -> Result

impl<__DB> ToSql<Nullable<Integer>, __DB> for i32 where
    __DB: Backend,
    Self: ToSql<Integer, __DB>, 

fn to_sql<W: Write>(&self, out: &mut Output<W, __DB>) -> Result

impl<__DB> ToSql<Nullable<BigInt>, __DB> for i64 where
    __DB: Backend,
    Self: ToSql<BigInt, __DB>, 

fn to_sql<W: Write>(&self, out: &mut Output<W, __DB>) -> Result

impl<__DB> ToSql<Nullable<Unsigned<TinyInt>>, __DB> for u8 where
    __DB: Backend,
    Self: ToSql<Unsigned<TinyInt>, __DB>, 

fn to_sql<W: Write>(&self, out: &mut Output<W, __DB>) -> Result

impl<__DB> ToSql<Nullable<Unsigned<SmallInt>>, __DB> for u16 where
    __DB: Backend,
    Self: ToSql<Unsigned<SmallInt>, __DB>, 

fn to_sql<W: Write>(&self, out: &mut Output<W, __DB>) -> Result

impl<__DB> ToSql<Nullable<Unsigned<Integer>>, __DB> for u32 where
    __DB: Backend,
    Self: ToSql<Unsigned<Integer>, __DB>, 

fn to_sql<W: Write>(&self, out: &mut Output<W, __DB>) -> Result

impl<__DB> ToSql<Nullable<Oid>, __DB> for u32 where
    __DB: Backend,
    Self: ToSql<Oid, __DB>, 

fn to_sql<W: Write>(&self, out: &mut Output<W, __DB>) -> Result

impl<__DB> ToSql<Nullable<Unsigned<BigInt>>, __DB> for u64 where
    __DB: Backend,
    Self: ToSql<Unsigned<BigInt>, __DB>, 

fn to_sql<W: Write>(&self, out: &mut Output<W, __DB>) -> Result

impl<__DB> ToSql<Nullable<Float>, __DB> for f32 where
    __DB: Backend,
    Self: ToSql<Float, __DB>, 

fn to_sql<W: Write>(&self, out: &mut Output<W, __DB>) -> Result

impl<__DB> ToSql<Nullable<Double>, __DB> for f64 where
    __DB: Backend,
    Self: ToSql<Double, __DB>, 

fn to_sql<W: Write>(&self, out: &mut Output<W, __DB>) -> Result

impl<__DB> ToSql<Nullable<Text>, __DB> for String where
    __DB: Backend,
    Self: ToSql<Text, __DB>, 

fn to_sql<W: Write>(&self, out: &mut Output<W, __DB>) -> Result

impl<__DB> ToSql<Nullable<Date>, __DB> for String where
    __DB: Backend,
    Self: ToSql<Date, __DB>, 

fn to_sql<W: Write>(&self, out: &mut Output<W, __DB>) -> Result

impl<__DB> ToSql<Nullable<Time>, __DB> for String where
    __DB: Backend,
    Self: ToSql<Time, __DB>, 

fn to_sql<W: Write>(&self, out: &mut Output<W, __DB>) -> Result

impl<__DB> ToSql<Nullable<Timestamp>, __DB> for String where
    __DB: Backend,
    Self: ToSql<Timestamp, __DB>, 

fn to_sql<W: Write>(&self, out: &mut Output<W, __DB>) -> Result

impl<__DB> ToSql<Nullable<Text>, __DB> for str where
    __DB: Backend,
    Self: ToSql<Text, __DB>, 

fn to_sql<W: Write>(&self, out: &mut Output<W, __DB>) -> Result

impl<__DB> ToSql<Nullable<Date>, __DB> for str where
    __DB: Backend,
    Self: ToSql<Date, __DB>, 

fn to_sql<W: Write>(&self, out: &mut Output<W, __DB>) -> Result

impl<__DB> ToSql<Nullable<Time>, __DB> for str where
    __DB: Backend,
    Self: ToSql<Time, __DB>, 

fn to_sql<W: Write>(&self, out: &mut Output<W, __DB>) -> Result

impl<__DB> ToSql<Nullable<Timestamp>, __DB> for str where
    __DB: Backend,
    Self: ToSql<Timestamp, __DB>, 

fn to_sql<W: Write>(&self, out: &mut Output<W, __DB>) -> Result

impl<__DB> ToSql<Nullable<Binary>, __DB> for Vec<u8> where
    __DB: Backend,
    Self: ToSql<Binary, __DB>, 

fn to_sql<W: Write>(&self, out: &mut Output<W, __DB>) -> Result

impl<__DB> ToSql<Nullable<Binary>, __DB> for [u8] where
    __DB: Backend,
    Self: ToSql<Binary, __DB>, 

fn to_sql<W: Write>(&self, out: &mut Output<W, __DB>) -> Result

impl<DB: Backend> ToSql<Text, DB> for str

fn to_sql<W: Write>(&self, out: &mut Output<W, DB>) -> Result

impl<DB> ToSql<Text, DB> for String where
    DB: Backend,
    str: ToSql<Text, DB>, 

fn to_sql<W: Write>(&self, out: &mut Output<W, DB>) -> Result

impl<DB> ToSql<Binary, DB> for Vec<u8> where
    DB: Backend,
    [u8]: ToSql<Binary, DB>, 

fn to_sql<W: Write>(&self, out: &mut Output<W, DB>) -> Result

impl<DB: Backend> ToSql<Binary, DB> for [u8]

fn to_sql<W: Write>(&self, out: &mut Output<W, DB>) -> Result

impl<'a, T: ?Sized, ST, DB> ToSql<ST, DB> for Cow<'a, T> where
    T: 'a + ToOwned + ToSql<ST, DB>,
    DB: Backend,
    Self: Debug, 

fn to_sql<W: Write>(&self, out: &mut Output<W, DB>) -> Result

Loading content...

Implementors

impl ToSql<Money, Pg> for PgMoney

fn to_sql<W: Write>(&self, out: &mut Output<W, Pg>) -> Result

impl ToSql<Timestamptz, Pg> for PgTimestamp

fn to_sql<W: Write>(&self, out: &mut Output<W, Pg>) -> Result

impl ToSql<Date, Pg> for PgDate

fn to_sql<W: Write>(&self, out: &mut Output<W, Pg>) -> Result

impl ToSql<Interval, Pg> for PgInterval

fn to_sql<W: Write>(&self, out: &mut Output<W, Pg>) -> Result

impl ToSql<Numeric, Pg> for PgNumeric

fn to_sql<W: Write>(&self, out: &mut Output<W, Pg>) -> Result

impl ToSql<Time, Pg> for PgTime

fn to_sql<W: Write>(&self, out: &mut Output<W, Pg>) -> Result

impl ToSql<Timestamp, Pg> for PgTimestamp

fn to_sql<W: Write>(&self, out: &mut Output<W, Pg>) -> Result

impl<__DB> ToSql<Nullable<Money>, __DB> for PgMoney where
    __DB: Backend,
    Self: ToSql<Money, __DB>, 

fn to_sql<W: Write>(&self, out: &mut Output<W, __DB>) -> Result

impl<__DB> ToSql<Nullable<Timestamptz>, __DB> for PgTimestamp where
    __DB: Backend,
    Self: ToSql<Timestamptz, __DB>, 

fn to_sql<W: Write>(&self, out: &mut Output<W, __DB>) -> Result

impl<__DB> ToSql<Nullable<Date>, __DB> for PgDate where
    __DB: Backend,
    Self: ToSql<Date, __DB>, 

fn to_sql<W: Write>(&self, out: &mut Output<W, __DB>) -> Result

impl<__DB> ToSql<Nullable<Interval>, __DB> for PgInterval where
    __DB: Backend,
    Self: ToSql<Interval, __DB>, 

fn to_sql<W: Write>(&self, out: &mut Output<W, __DB>) -> Result

impl<__DB> ToSql<Nullable<Numeric>, __DB> for PgNumeric where
    __DB: Backend,
    Self: ToSql<Numeric, __DB>, 

fn to_sql<W: Write>(&self, out: &mut Output<W, __DB>) -> Result

impl<__DB> ToSql<Nullable<Time>, __DB> for PgTime where
    __DB: Backend,
    Self: ToSql<Time, __DB>, 

fn to_sql<W: Write>(&self, out: &mut Output<W, __DB>) -> Result

impl<__DB> ToSql<Nullable<Timestamp>, __DB> for PgTimestamp where
    __DB: Backend,
    Self: ToSql<Timestamp, __DB>, 

fn to_sql<W: Write>(&self, out: &mut Output<W, __DB>) -> Result

Loading content...