Trait Encode 

pub trait Encode<'q, DB>
where
    DB: Database,
{
    // Required method
    fn encode_by_ref(
        &self,
        buf: &mut <DB as Database>::ArgumentBuffer<'q>,
    ) -> Result<IsNull, Box<dyn Error + Sync + Send>>;

    // Provided methods
    fn encode(
        self,
        buf: &mut <DB as Database>::ArgumentBuffer<'q>,
    ) -> Result<IsNull, Box<dyn Error + Sync + Send>>
       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 Database>::ArgumentBuffer<'q>, ) -> Result<IsNull, Box<dyn Error + Sync + Send>>

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 Database>::ArgumentBuffer<'q>, ) -> Result<IsNull, Box<dyn Error + Sync + Send>>

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, ) -> Result<IsNull, Box<dyn Error + Sync + Send>>

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

fn encode_by_ref( &self, buf: &mut PgArgumentBuffer, ) -> Result<IsNull, Box<dyn Error + Sync + Send>>

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

fn encode_by_ref( &self, buf: &mut PgArgumentBuffer, ) -> Result<IsNull, Box<dyn Error + Sync + Send>>

impl Encode<'_, Postgres> for bool

fn encode_by_ref( &self, buf: &mut PgArgumentBuffer, ) -> Result<IsNull, Box<dyn Error + Sync + Send>>

impl Encode<'_, Postgres> for f32

fn encode_by_ref( &self, buf: &mut PgArgumentBuffer, ) -> Result<IsNull, Box<dyn Error + Sync + Send>>

impl Encode<'_, Postgres> for f64

fn encode_by_ref( &self, buf: &mut PgArgumentBuffer, ) -> Result<IsNull, Box<dyn Error + Sync + Send>>

impl Encode<'_, Postgres> for i8

fn encode_by_ref( &self, buf: &mut PgArgumentBuffer, ) -> Result<IsNull, Box<dyn Error + Sync + Send>>

impl Encode<'_, Postgres> for i16

fn encode_by_ref( &self, buf: &mut PgArgumentBuffer, ) -> Result<IsNull, Box<dyn Error + Sync + Send>>

impl Encode<'_, Postgres> for i32

fn encode_by_ref( &self, buf: &mut PgArgumentBuffer, ) -> Result<IsNull, Box<dyn Error + Sync + Send>>

impl Encode<'_, Postgres> for i64

fn encode_by_ref( &self, buf: &mut PgArgumentBuffer, ) -> Result<IsNull, Box<dyn Error + Sync + Send>>

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

fn encode_by_ref( &self, buf: &mut PgArgumentBuffer, ) -> Result<IsNull, Box<dyn Error + Sync + Send>>

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

fn encode_by_ref( &self, buf: &mut PgArgumentBuffer, ) -> Result<IsNull, Box<dyn Error + Sync + Send>>

impl Encode<'_, Postgres> for String

fn encode_by_ref( &self, buf: &mut PgArgumentBuffer, ) -> Result<IsNull, Box<dyn Error + Sync + Send>>

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

fn encode_by_ref( &self, buf: &mut PgArgumentBuffer, ) -> Result<IsNull, Box<dyn Error + Sync + Send>>

impl Encode<'_, Postgres> for Duration

fn encode_by_ref( &self, buf: &mut PgArgumentBuffer, ) -> Result<IsNull, Box<dyn Error + Sync + Send>>

fn size_hint(&self) -> usize

impl Encode<'_, Postgres> for TimeDelta

Available on crate feature chrono only.

fn encode_by_ref( &self, buf: &mut PgArgumentBuffer, ) -> Result<IsNull, Box<dyn Error + Sync + Send>>

fn size_hint(&self) -> usize

impl Encode<'_, Postgres> for Duration

Available on crate feature time only.

fn encode_by_ref( &self, buf: &mut PgArgumentBuffer, ) -> Result<IsNull, Box<dyn Error + Sync + Send>>

fn size_hint(&self) -> usize

impl<'q, DB> Encode<'q, DB> for NonZero<i8>

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

fn encode_by_ref( &self, buf: &mut <DB as Database>::ArgumentBuffer<'q>, ) -> Result<IsNull, Box<dyn Error + Sync + Send>>

fn encode( self, buf: &mut <DB as Database>::ArgumentBuffer<'q>, ) -> Result<IsNull, Box<dyn Error + Sync + Send>>

where NonZero<i8>: Sized,

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

impl<'q, DB> Encode<'q, DB> for NonZero<i16>

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

fn encode_by_ref( &self, buf: &mut <DB as Database>::ArgumentBuffer<'q>, ) -> Result<IsNull, Box<dyn Error + Sync + Send>>

fn encode( self, buf: &mut <DB as Database>::ArgumentBuffer<'q>, ) -> Result<IsNull, Box<dyn Error + Sync + Send>>

where NonZero<i16>: Sized,

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

impl<'q, DB> Encode<'q, DB> for NonZero<i32>

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

fn encode_by_ref( &self, buf: &mut <DB as Database>::ArgumentBuffer<'q>, ) -> Result<IsNull, Box<dyn Error + Sync + Send>>

fn encode( self, buf: &mut <DB as Database>::ArgumentBuffer<'q>, ) -> Result<IsNull, Box<dyn Error + Sync + Send>>

where NonZero<i32>: Sized,

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

impl<'q, DB> Encode<'q, DB> for NonZero<i64>

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

fn encode_by_ref( &self, buf: &mut <DB as Database>::ArgumentBuffer<'q>, ) -> Result<IsNull, Box<dyn Error + Sync + Send>>

fn encode( self, buf: &mut <DB as Database>::ArgumentBuffer<'q>, ) -> Result<IsNull, Box<dyn Error + Sync + Send>>

where NonZero<i64>: Sized,

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

impl<'q, DB> Encode<'q, DB> for NonZero<u8>

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

fn encode_by_ref( &self, buf: &mut <DB as Database>::ArgumentBuffer<'q>, ) -> Result<IsNull, Box<dyn Error + Sync + Send>>

fn encode( self, buf: &mut <DB as Database>::ArgumentBuffer<'q>, ) -> Result<IsNull, Box<dyn Error + Sync + Send>>

where NonZero<u8>: Sized,

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

impl<'q, DB> Encode<'q, DB> for NonZero<u16>

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

fn encode_by_ref( &self, buf: &mut <DB as Database>::ArgumentBuffer<'q>, ) -> Result<IsNull, Box<dyn Error + Sync + Send>>

fn encode( self, buf: &mut <DB as Database>::ArgumentBuffer<'q>, ) -> Result<IsNull, Box<dyn Error + Sync + Send>>

where NonZero<u16>: Sized,

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

impl<'q, DB> Encode<'q, DB> for NonZero<u32>

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

fn encode_by_ref( &self, buf: &mut <DB as Database>::ArgumentBuffer<'q>, ) -> Result<IsNull, Box<dyn Error + Sync + Send>>

fn encode( self, buf: &mut <DB as Database>::ArgumentBuffer<'q>, ) -> Result<IsNull, Box<dyn Error + Sync + Send>>

where NonZero<u32>: Sized,

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

impl<'q, DB> Encode<'q, DB> for NonZero<u64>

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

fn encode_by_ref( &self, buf: &mut <DB as Database>::ArgumentBuffer<'q>, ) -> Result<IsNull, Box<dyn Error + Sync + Send>>

fn encode( self, buf: &mut <DB as Database>::ArgumentBuffer<'q>, ) -> Result<IsNull, Box<dyn Error + Sync + Send>>

where NonZero<u64>: Sized,

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

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

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

fn encode_by_ref( &self, buf: &mut PgArgumentBuffer, ) -> Result<IsNull, Box<dyn Error + Sync + Send>>

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 Database>::ArgumentBuffer<'q>, ) -> Result<IsNull, Box<dyn Error + Sync + Send>>

fn encode_by_ref( &self, buf: &mut <Postgres as Database>::ArgumentBuffer<'q>, ) -> Result<IsNull, Box<dyn Error + Sync + Send>>

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, ) -> Result<IsNull, Box<dyn Error + Sync + Send>>

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

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

fn encode( self, buf: &mut <DB as Database>::ArgumentBuffer<'q>, ) -> Result<IsNull, Box<dyn Error + Sync + Send>>

fn encode_by_ref( &self, buf: &mut <DB as Database>::ArgumentBuffer<'q>, ) -> Result<IsNull, Box<dyn Error + Sync + Send>>

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, ) -> Result<IsNull, Box<dyn Error + Sync + Send>>

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

fn encode_by_ref( &self, buf: &mut PgArgumentBuffer, ) -> Result<IsNull, Box<dyn Error + Sync + Send>>

Implementors

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 NaiveDate

impl Encode<'_, Postgres> for NaiveDateTime

impl Encode<'_, Postgres> for Decimal

impl Encode<'_, Postgres> for NaiveTime

impl Encode<'_, Postgres> for Date

impl Encode<'_, Postgres> for PrimitiveDateTime

impl Encode<'_, Postgres> for OffsetDateTime

impl Encode<'_, Postgres> for Time

impl Encode<'_, Postgres> for Uuid

impl Encode<'_, Postgres> for Oid

impl Encode<'_, Postgres> for PgCiText

impl Encode<'_, Postgres> for PgHstore

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<'q> Encode<'q, Postgres> for PgCube

impl<'q> Encode<'q, Postgres> for PgBox

impl<'q> Encode<'q, Postgres> for PgCircle

impl<'q> Encode<'q, Postgres> for PgLSeg

impl<'q> Encode<'q, Postgres> for PgLine

impl<'q> Encode<'q, Postgres> for PgPath

impl<'q> Encode<'q, Postgres> for PgPoint

impl<'q> Encode<'q, Postgres> for PgPolygon

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<Tz> Encode<'_, Postgres> for DateTime<Tz>

where Tz: TimeZone,