Trait FromSql

Source

pub trait FromSql<A, DB: Backend>: Sized {
    // Required method
    fn from_sql(bytes: DB::RawValue<'_>) -> Result<Self>;

    // Provided method
    fn from_nullable_sql(bytes: Option<DB::RawValue<'_>>) -> Result<Self> { ... }
}

Expand description

Deserialize a single field of a given SQL type.

When possible, implementations of this trait should prefer to use an existing implementation, rather than reading from bytes. (For example, if you are implementing this for an enum which is represented as an integer in the database, prefer i32::from_sql(bytes) (or the explicit form <i32 as FromSql<Integer, DB>>::from_sql(bytes)) over reading from bytes directly)

Types which implement this trait should also have #[derive(FromSqlRow)]

§Backend specific details

For PostgreSQL, the bytes will be sent using the binary protocol, not text.
For SQLite, the actual type of DB::RawValue is private API. All implementations of this trait must be written in terms of an existing primitive.
For MySQL, the value of 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, FromSqlRow)]
pub enum MyEnum {
    A = 1,
    B = 2,
}

impl<DB> FromSql<Integer, DB> for MyEnum
where
    DB: Backend,
    i32: FromSql<Integer, DB>,
{
    fn from_sql(bytes: DB::RawValue<'_>) -> deserialize::Result<Self> {
        match i32::from_sql(bytes)? {
            1 => Ok(MyEnum::A),
            2 => Ok(MyEnum::B),
            x => Err(format!("Unrecognized variant {}", x).into()),
        }
    }
}

Required Methods§

Source

fn from_sql(bytes: DB::RawValue<'_>) -> Result<Self>

See the trait documentation.

Provided Methods§

Source

fn from_nullable_sql(bytes: Option<DB::RawValue<'_>>) -> Result<Self>

A specialized variant of from_sql for handling null values.

The default implementation returns an UnexpectedNullError for an encountered null value and calls Self::from_sql otherwise

If your custom type supports null values you need to provide a custom implementation.

Dyn Compatibility§

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Trait FromSqlCopy item path

§Backend specific details

§Examples

Required Methods§

fn from_sql(bytes: DB::RawValue<'_>) -> Result<Self>

Provided Methods§

fn from_nullable_sql(bytes: Option<DB::RawValue<'_>>) -> Result<Self>

Dyn Compatibility§

Implementations on Foreign Types§

impl FromSql<BigInt, Mysql> for i64

fn from_sql(value: MysqlValue<'_>) -> Result<Self>

impl FromSql<BigInt, Pg> for i64

fn from_sql(value: PgValue<'_>) -> Result<Self>

impl FromSql<BigInt, Sqlite> for i64

fn from_sql(value: SqliteValue<'_, '_, '_>) -> Result<Self>

impl FromSql<Binary, Mysql> for *const [u8]

fn from_sql(value: MysqlValue<'_>) -> Result<Self>

impl FromSql<Binary, Pg> for *const [u8]

fn from_sql(value: PgValue<'_>) -> Result<Self>

impl FromSql<Binary, Sqlite> for *const [u8]

fn from_sql(bytes: SqliteValue<'_, '_, '_>) -> Result<Self>

impl FromSql<Bool, Mysql> for bool

fn from_sql(bytes: MysqlValue<'_>) -> Result<Self>

impl FromSql<Bool, Pg> for bool

fn from_sql(bytes: PgValue<'_>) -> Result<Self>

impl FromSql<Bool, Sqlite> for bool

fn from_sql(value: SqliteValue<'_, '_, '_>) -> Result<Self>

impl FromSql<CChar, Pg> for u8

fn from_sql(bytes: PgValue<'_>) -> Result<Self>

impl FromSql<Cidr, Pg> for IpNetwork

fn from_sql(value: PgValue<'_>) -> Result<Self>

impl FromSql<Citext, Pg> for String

fn from_sql(value: PgValue<'_>) -> Result<Self>

impl FromSql<Date, Mysql> for NaiveDate

fn from_sql(bytes: MysqlValue<'_>) -> Result<Self>

impl FromSql<Date, Mysql> for Date

fn from_sql(bytes: MysqlValue<'_>) -> Result<Self>

impl FromSql<Date, Pg> for NaiveDate

fn from_sql(bytes: PgValue<'_>) -> Result<Self>

impl FromSql<Date, Pg> for Date

fn from_sql(bytes: PgValue<'_>) -> Result<Self>

impl FromSql<Date, Sqlite> for String

fn from_sql(value: SqliteValue<'_, '_, '_>) -> Result<Self>

impl FromSql<Date, Sqlite> for NaiveDate

fn from_sql(value: <Sqlite as Backend>::RawValue<'_>) -> Result<Self>

impl FromSql<Date, Sqlite> for Date

fn from_sql(value: <Sqlite as Backend>::RawValue<'_>) -> Result<Self>

impl FromSql<Datetime, Mysql> for NaiveDateTime

fn from_sql(bytes: MysqlValue<'_>) -> Result<Self>

impl FromSql<Datetime, Mysql> for OffsetDateTime

fn from_sql(bytes: MysqlValue<'_>) -> Result<Self>

impl FromSql<Datetime, Mysql> for PrimitiveDateTime

fn from_sql(bytes: MysqlValue<'_>) -> Result<Self>

impl FromSql<Double, Mysql> for f64

fn from_sql(value: MysqlValue<'_>) -> Result<Self>

impl FromSql<Double, Pg> for f64

fn from_sql(value: PgValue<'_>) -> Result<Self>

impl FromSql<Double, Sqlite> for f64

fn from_sql(value: SqliteValue<'_, '_, '_>) -> Result<Self>

impl FromSql<Float, Mysql> for f32

fn from_sql(value: MysqlValue<'_>) -> Result<Self>

impl FromSql<Float, Pg> for f32

fn from_sql(value: PgValue<'_>) -> Result<Self>

impl FromSql<Float, Sqlite> for f32

fn from_sql(value: SqliteValue<'_, '_, '_>) -> Result<Self>

impl FromSql<Inet, Pg> for IpNetwork

fn from_sql(value: PgValue<'_>) -> Result<Self>

impl FromSql<Integer, Mysql> for i32

fn from_sql(value: MysqlValue<'_>) -> Result<Self>

impl FromSql<Integer, Pg> for i32

fn from_sql(value: PgValue<'_>) -> Result<Self>

impl FromSql<Integer, Sqlite> for i32

fn from_sql(value: SqliteValue<'_, '_, '_>) -> Result<Self>

impl FromSql<Interval, Pg> for Duration

fn from_sql(bytes: PgValue<'_>) -> Result<Self>

impl FromSql<Json, Mysql> for Value

fn from_sql(value: MysqlValue<'_>) -> Result<Self>

impl FromSql<Json, Pg> for Value

fn from_sql(value: PgValue<'_>) -> Result<Self>

impl FromSql<Jsonb, Pg> for Value

Trait FromSql