pub trait Encode<'q, DB>where
DB: Database,{
// Required method
fn encode_by_ref(
&self,
buf: &mut <DB as Database>::ArgumentBuffer,
) -> Result<IsNull, Box<dyn Error + Sync + Send>>;
// Provided methods
fn encode(
self,
buf: &mut <DB as Database>::ArgumentBuffer,
) -> Result<IsNull, Box<dyn Error + Sync + Send>>
where Self: Sized { ... }
fn produces(&self) -> Option<<DB as Database>::TypeInfo> { ... }
fn size_hint(&self) -> usize { ... }
}Expand description
Encode a single value to be sent to the database.
Required Methods§
Sourcefn encode_by_ref(
&self,
buf: &mut <DB as Database>::ArgumentBuffer,
) -> Result<IsNull, Box<dyn Error + Sync + Send>>
fn encode_by_ref( &self, buf: &mut <DB as Database>::ArgumentBuffer, ) -> 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§
Sourcefn encode(
self,
buf: &mut <DB as Database>::ArgumentBuffer,
) -> Result<IsNull, Box<dyn Error + Sync + Send>>where
Self: Sized,
fn encode(
self,
buf: &mut <DB as Database>::ArgumentBuffer,
) -> 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
Dyn Compatibility§
This trait is dyn compatible.
In older versions of Rust, dyn compatibility was called "object safety".
Implementations on Foreign Types§
Source§impl Encode<'_, Any> for f32
impl Encode<'_, Any> for f32
fn encode_by_ref( &self, buf: &mut AnyArgumentBuffer, ) -> Result<IsNull, Box<dyn Error + Sync + Send>>
Source§impl Encode<'_, MySql> for BigDecimal
impl Encode<'_, MySql> for BigDecimal
Source§impl Encode<'_, MySql> for DateTime<Local>
Note: assumes the connection’s time_zone is set to +00:00 (UTC).
impl Encode<'_, MySql> for DateTime<Local>
Note: assumes the connection’s time_zone is set to +00:00 (UTC).
Source§impl Encode<'_, MySql> for DateTime<Utc>
Note: assumes the connection’s time_zone is set to +00:00 (UTC).
impl Encode<'_, MySql> for DateTime<Utc>
Note: assumes the connection’s time_zone is set to +00:00 (UTC).
Source§impl Encode<'_, MySql> for Hyphenated
impl Encode<'_, MySql> for Hyphenated
Source§impl Encode<'_, MySql> for NaiveDateTime
impl Encode<'_, MySql> for NaiveDateTime
Source§impl Encode<'_, MySql> for OffsetDateTime
impl Encode<'_, MySql> for OffsetDateTime
Source§impl Encode<'_, MySql> for PrimitiveDateTime
impl Encode<'_, MySql> for PrimitiveDateTime
Source§impl Encode<'_, Postgres> for &[u8]
impl Encode<'_, Postgres> for &[u8]
fn encode_by_ref( &self, buf: &mut PgArgumentBuffer, ) -> Result<IsNull, Box<dyn Error + Sync + Send>>
Source§impl Encode<'_, Postgres> for &str
impl Encode<'_, Postgres> for &str
fn encode_by_ref( &self, buf: &mut PgArgumentBuffer, ) -> Result<IsNull, Box<dyn Error + Sync + Send>>
Source§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.
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 263 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.