Trait Encode

pub trait Encode<'q, DB>
where
    DB: Database,
{
    // Required method
    fn encode_by_ref(
        &self,
        buf: &mut <DB as HasArguments<'q>>::ArgumentBuffer,
    ) -> IsNull;

    // Provided methods
    fn encode(
        self,
        buf: &mut <DB as HasArguments<'q>>::ArgumentBuffer,
    ) -> IsNull
       where Self: Sized { ... }
    fn produces(&self) -> Option<<DB as Database>::TypeInfo> { ... }
    fn size_hint(&self) -> usize { ... }
}

Encode a single value to be sent to the database.

Required Methods

fn encode_by_ref( &self, buf: &mut <DB as HasArguments<'q>>::ArgumentBuffer, ) -> IsNull

Writes the value of self into buf without moving self.

Where possible, make use of encode instead as it can take advantage of re-using memory.

Provided Methods

fn encode(self, buf: &mut <DB as HasArguments<'q>>::ArgumentBuffer) -> IsNull

where Self: Sized,

Writes the value of self into buf in the expected format for the database.

fn produces(&self) -> Option<<DB as Database>::TypeInfo>

fn size_hint(&self) -> usize

Implementations on Foreign Types

impl Encode<'_, Postgres> for &str

fn encode_by_ref(&self, buf: &mut PgArgumentBuffer) -> IsNull

impl Encode<'_, Postgres> for &[u8]

fn encode_by_ref(&self, buf: &mut PgArgumentBuffer) -> IsNull

impl Encode<'_, Postgres> for Cow<'_, str>

fn encode_by_ref(&self, buf: &mut PgArgumentBuffer) -> IsNull

impl Encode<'_, Postgres> for bool

fn encode_by_ref(&self, buf: &mut PgArgumentBuffer) -> IsNull

impl Encode<'_, Postgres> for f32

fn encode_by_ref(&self, buf: &mut PgArgumentBuffer) -> IsNull

impl Encode<'_, Postgres> for f64

fn encode_by_ref(&self, buf: &mut PgArgumentBuffer) -> IsNull

impl Encode<'_, Postgres> for i8

fn encode_by_ref(&self, buf: &mut PgArgumentBuffer) -> IsNull

impl Encode<'_, Postgres> for i16

fn encode_by_ref(&self, buf: &mut PgArgumentBuffer) -> IsNull

impl Encode<'_, Postgres> for i32

fn encode_by_ref(&self, buf: &mut PgArgumentBuffer) -> IsNull

impl Encode<'_, Postgres> for i64

fn encode_by_ref(&self, buf: &mut PgArgumentBuffer) -> IsNull

impl Encode<'_, Postgres> for Box<str>

fn encode_by_ref(&self, buf: &mut PgArgumentBuffer) -> IsNull

impl Encode<'_, Postgres> for Box<[u8]>

fn encode_by_ref(&self, buf: &mut PgArgumentBuffer) -> IsNull

impl Encode<'_, Postgres> for String

fn encode_by_ref(&self, buf: &mut PgArgumentBuffer) -> IsNull

impl Encode<'_, Postgres> for Vec<u8>

fn encode_by_ref(&self, buf: &mut PgArgumentBuffer) -> IsNull

impl Encode<'_, Postgres> for Duration

fn encode_by_ref(&self, buf: &mut PgArgumentBuffer) -> IsNull

fn size_hint(&self) -> usize

impl Encode<'_, Postgres> for TimeDelta

fn encode_by_ref(&self, buf: &mut PgArgumentBuffer) -> IsNull

fn size_hint(&self) -> usize

impl Encode<'_, Postgres> for Duration

fn encode_by_ref(&self, buf: &mut PgArgumentBuffer) -> IsNull

fn size_hint(&self) -> usize

impl Encode<'_, Sqlite> for Box<str>

fn encode(self, args: &mut Vec<SqliteArgumentValue<'_>>) -> IsNull

fn encode_by_ref(&self, args: &mut Vec<SqliteArgumentValue<'_>>) -> IsNull

impl Encode<'_, Sqlite> for Box<[u8]>

fn encode(self, args: &mut Vec<SqliteArgumentValue<'_>>) -> IsNull

fn encode_by_ref(&self, args: &mut Vec<SqliteArgumentValue<'_>>) -> IsNull

impl<'a> Encode<'a, Any> for &'a str

fn encode(self, buf: &mut <Any as HasArguments<'a>>::ArgumentBuffer) -> IsNull

where &'a str: Sized,

fn encode_by_ref( &self, buf: &mut <Any as HasArguments<'a>>::ArgumentBuffer, ) -> IsNull

impl<'db> Encode<'db, Postgres> for IpAddr

where IpNetwork: Encode<'db, Postgres>,

fn encode_by_ref(&self, buf: &mut PgArgumentBuffer) -> IsNull

fn size_hint(&self) -> usize

impl<'q> Encode<'q, Any> for &'q [u8]

fn encode_by_ref( &self, buf: &mut <Any as HasArguments<'q>>::ArgumentBuffer, ) -> IsNull

impl<'q> Encode<'q, Any> for bool

fn encode_by_ref( &self, buf: &mut <Any as HasArguments<'q>>::ArgumentBuffer, ) -> IsNull

impl<'q> Encode<'q, Any> for f32

fn encode_by_ref(&self, buf: &mut AnyArgumentBuffer<'q>) -> IsNull

impl<'q> Encode<'q, Any> for f64

fn encode_by_ref( &self, buf: &mut <Any as HasArguments<'q>>::ArgumentBuffer, ) -> IsNull

impl<'q> Encode<'q, Any> for i16

fn encode_by_ref( &self, buf: &mut <Any as HasArguments<'q>>::ArgumentBuffer, ) -> IsNull

impl<'q> Encode<'q, Any> for i32

fn encode_by_ref( &self, buf: &mut <Any as HasArguments<'q>>::ArgumentBuffer, ) -> IsNull

impl<'q> Encode<'q, Any> for i64

fn encode_by_ref( &self, buf: &mut <Any as HasArguments<'q>>::ArgumentBuffer, ) -> IsNull

impl<'q> Encode<'q, Any> for String

fn encode_by_ref( &self, buf: &mut <Any as HasArguments<'q>>::ArgumentBuffer, ) -> IsNull

impl<'q> Encode<'q, Any> for Vec<u8>

fn encode_by_ref( &self, buf: &mut <Any as HasArguments<'q>>::ArgumentBuffer, ) -> IsNull

impl<'q> Encode<'q, Sqlite> for &'q str

fn encode_by_ref(&self, args: &mut Vec<SqliteArgumentValue<'q>>) -> IsNull

impl<'q> Encode<'q, Sqlite> for &'q [u8]

fn encode_by_ref(&self, args: &mut Vec<SqliteArgumentValue<'q>>) -> IsNull

impl<'q> Encode<'q, Sqlite> for Cow<'q, str>

fn encode(self, args: &mut Vec<SqliteArgumentValue<'q>>) -> IsNull

fn encode_by_ref(&self, args: &mut Vec<SqliteArgumentValue<'q>>) -> IsNull

impl<'q> Encode<'q, Sqlite> for bool

fn encode_by_ref(&self, args: &mut Vec<SqliteArgumentValue<'q>>) -> IsNull

impl<'q> Encode<'q, Sqlite> for f32

fn encode_by_ref(&self, args: &mut Vec<SqliteArgumentValue<'q>>) -> IsNull

impl<'q> Encode<'q, Sqlite> for f64

fn encode_by_ref(&self, args: &mut Vec<SqliteArgumentValue<'q>>) -> IsNull

impl<'q> Encode<'q, Sqlite> for i8

fn encode_by_ref(&self, args: &mut Vec<SqliteArgumentValue<'q>>) -> IsNull

impl<'q> Encode<'q, Sqlite> for i16

fn encode_by_ref(&self, args: &mut Vec<SqliteArgumentValue<'q>>) -> IsNull

impl<'q> Encode<'q, Sqlite> for i32

fn encode_by_ref(&self, args: &mut Vec<SqliteArgumentValue<'q>>) -> IsNull

impl<'q> Encode<'q, Sqlite> for i64

fn encode_by_ref(&self, args: &mut Vec<SqliteArgumentValue<'q>>) -> IsNull

impl<'q> Encode<'q, Sqlite> for u8

fn encode_by_ref(&self, args: &mut Vec<SqliteArgumentValue<'q>>) -> IsNull

impl<'q> Encode<'q, Sqlite> for u16

fn encode_by_ref(&self, args: &mut Vec<SqliteArgumentValue<'q>>) -> IsNull

impl<'q> Encode<'q, Sqlite> for u32

fn encode_by_ref(&self, args: &mut Vec<SqliteArgumentValue<'q>>) -> IsNull

impl<'q> Encode<'q, Sqlite> for String

fn encode(self, args: &mut Vec<SqliteArgumentValue<'q>>) -> IsNull

fn encode_by_ref(&self, args: &mut Vec<SqliteArgumentValue<'q>>) -> IsNull

impl<'q> Encode<'q, Sqlite> for Vec<u8>

fn encode(self, args: &mut Vec<SqliteArgumentValue<'q>>) -> IsNull

fn encode_by_ref(&self, args: &mut Vec<SqliteArgumentValue<'q>>) -> IsNull

impl<'q, T> Encode<'q, Any> for Option<T>

where T: Encode<'q, Any> + 'q + Type<Any>,

fn encode_by_ref(&self, buf: &mut AnyArgumentBuffer<'q>) -> IsNull

impl<'q, T> Encode<'q, Postgres> for &[T]

where T: Encode<'q, Postgres> + Type<Postgres>,

fn encode_by_ref(&self, buf: &mut PgArgumentBuffer) -> IsNull

impl<'q, T> Encode<'q, Postgres> for Option<T>

where T: Encode<'q, Postgres> + Type<Postgres> + 'q,

fn produces(&self) -> Option<<Postgres as Database>::TypeInfo>

fn encode( self, buf: &mut <Postgres as HasArguments<'q>>::ArgumentBuffer, ) -> IsNull

fn encode_by_ref( &self, buf: &mut <Postgres as HasArguments<'q>>::ArgumentBuffer, ) -> IsNull

fn size_hint(&self) -> usize

impl<'q, T> Encode<'q, Postgres> for Vec<T>

where &'a [T]: for<'a> Encode<'q, Postgres>, T: Encode<'q, Postgres>,

fn encode_by_ref(&self, buf: &mut PgArgumentBuffer) -> IsNull

impl<'q, T> Encode<'q, Sqlite> for Option<T>

where T: Encode<'q, Sqlite> + Type<Sqlite> + 'q,

fn produces(&self) -> Option<<Sqlite as Database>::TypeInfo>

fn encode( self, buf: &mut <Sqlite as HasArguments<'q>>::ArgumentBuffer, ) -> IsNull

fn encode_by_ref( &self, buf: &mut <Sqlite as HasArguments<'q>>::ArgumentBuffer, ) -> IsNull

fn size_hint(&self) -> usize

impl<'q, T, DB> Encode<'q, DB> for &T

where DB: Database, T: Encode<'q, DB>,

fn encode(self, buf: &mut <DB as HasArguments<'q>>::ArgumentBuffer) -> IsNull

fn encode_by_ref( &self, buf: &mut <DB as HasArguments<'q>>::ArgumentBuffer, ) -> IsNull

fn produces(&self) -> Option<<DB as Database>::TypeInfo>

fn size_hint(&self) -> usize

impl<'q, T, const N: usize> Encode<'q, Postgres> for [T; N]

where &'a [T]: for<'a> Encode<'q, Postgres>, T: Encode<'q, Postgres>,

fn encode_by_ref(&self, buf: &mut PgArgumentBuffer) -> IsNull

impl<const N: usize> Encode<'_, Postgres> for [u8; N]

fn encode_by_ref(&self, buf: &mut PgArgumentBuffer) -> IsNull

Implementors

impl Encode<'_, Postgres> for IpNetwork

impl Encode<'_, Postgres> for Oid

impl Encode<'_, Postgres> for PgCiText

impl Encode<'_, Postgres> for PgInterval

impl Encode<'_, Postgres> for PgLQuery

impl Encode<'_, Postgres> for PgLTree

impl Encode<'_, Postgres> for PgMoney

impl Encode<'_, Postgres> for PgTimeTz

impl Encode<'_, Postgres> for PgTimeTz<NaiveTime, FixedOffset>

impl Encode<'_, Postgres> for NaiveDate

impl Encode<'_, Postgres> for NaiveDateTime

impl Encode<'_, Postgres> for NaiveTime

impl Encode<'_, Postgres> for MacAddress

impl Encode<'_, Postgres> for BigDecimal

Note: BigDecimal Has a Larger Range than NUMERIC

BigDecimal can represent values with a far, far greater range than the NUMERIC type in Postgres can.

NUMERIC is limited to 131,072 digits before the decimal point, and 16,384 digits after it. See Section 8.1, Numeric Types of the Postgres manual for details.

Meanwhile, BigDecimal can theoretically represent a value with an arbitrary number of decimal digits, albeit with a maximum of 2⁶³ significant figures.

Because encoding in the current API design must be infallible, when attempting to encode a BigDecimal that cannot fit in the wire representation of NUMERIC, SQLx may instead encode a sentinel value that falls outside the allowed range but is still representable.

This will cause the query to return a DatabaseError with code 22P03 (invalid_binary_representation) and the error message invalid scale in external "numeric" value (though this may be subject to change).

However, BigDecimal should be able to decode any NUMERIC value except NaN, for which it has no representation.

impl Encode<'_, Postgres> for BitVec

impl Encode<'_, Postgres> for Decimal

impl Encode<'_, Postgres> for Uuid

impl Encode<'_, Postgres> for Date

impl Encode<'_, Postgres> for OffsetDateTime

impl Encode<'_, Postgres> for PrimitiveDateTime

impl Encode<'_, Postgres> for Time

impl Encode<'_, Sqlite> for NaiveDate

impl Encode<'_, Sqlite> for NaiveDateTime

impl Encode<'_, Sqlite> for NaiveTime

impl Encode<'_, Sqlite> for Date

impl Encode<'_, Sqlite> for OffsetDateTime

impl Encode<'_, Sqlite> for PrimitiveDateTime

impl Encode<'_, Sqlite> for Time

impl<'q> Encode<'q, Sqlite> for Uuid

impl<'q> Encode<'q, Sqlite> for Hyphenated

impl<'q> Encode<'q, Sqlite> for Simple

impl<'q, DB> Encode<'q, DB> for Value

where Json<&'a Value>: for<'a> Encode<'q, DB>, DB: Database,

impl<'q, T> Encode<'q, Postgres> for PgRange<T>

where T: Encode<'q, Postgres>,

impl<'q, T> Encode<'q, Postgres> for Json<T>

where T: Serialize,

impl<'q, T> Encode<'q, Postgres> for Text<T>

where T: Display,

impl<'q, T> Encode<'q, Sqlite> for Text<T>

where T: Display,

impl<T> Encode<'_, Sqlite> for Json<T>

where T: Serialize,

impl<Tz> Encode<'_, Postgres> for DateTime<Tz>

where Tz: TimeZone,

impl<Tz> Encode<'_, Sqlite> for DateTime<Tz>

where Tz: TimeZone, <Tz as TimeZone>::Offset: Display,