Struct sqlx::types::Json

pub struct Json<T>(pub T)
where
    T: ?Sized;

Json for json and jsonb fields

Will attempt to cast to type passed in as the generic.

[dependencies]
serde_json = { version = "1.0", features = ["raw_value"] }

Example

#[derive(Deserialize)]
struct Book {
  name: String
}

#[derive(sqlx::FromRow)]
struct Author {
  name: String,
  books: sqlx::types::Json<Book>
}

Can also be used to turn the json/jsonb into a hashmap

use std::collections::HashMap;
use serde::Deserialize;

#[derive(Deserialize)]
struct Book {
  name: String
}
#[derive(sqlx::FromRow)]
struct Library {
  id: String,
  dewey_decimal: sqlx::types::Json<HashMap<String, Book>>
}

If the query macros are used, it is necessary to tell the macro to use the Json adapter by using the type override syntax

#[derive(sqlx::FromRow)]
struct Book {
    title: String,
}

#[derive(sqlx::FromRow)]
struct Author {
    name: String,
    books: sqlx::types::Json<Book>,
}
// Note the type override in the query string
let authors = sqlx::query_as!(
    Author,
    r#"
SELECT name, books as "books: Json<Book>"
FROM authors
    "#
)
.fetch_all(&mut conn)
.await?;

Tuple Fields

0: T

Trait Implementations

impl<T> AsMut<T> for Json<T>

fn as_mut(&mut self) -> &mut T

Converts this type into a mutable reference of the (usually inferred) input type.

impl<T> AsRef<T> for Json<T>

fn as_ref(&self) -> &T

Converts this type into a shared reference of the (usually inferred) input type.

impl<T> Clone for Json<T>

where T: Clone + ?Sized,

fn clone(&self) -> Json<T>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T> Debug for Json<T>

where T: Debug + ?Sized,

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<'r, T> Decode<'r, MySql> for Json<T>

where T: 'r + Deserialize<'r>,

fn decode( value: MySqlValueRef<'r>, ) -> Result<Json<T>, Box<dyn Error + Sync + Send>>

Decode a new value of this type using a raw value from the database.

impl<'r, T> Decode<'r, Postgres> for Json<T>

where T: 'r + Deserialize<'r>,

fn decode( value: PgValueRef<'r>, ) -> Result<Json<T>, Box<dyn Error + Sync + Send>>

Decode a new value of this type using a raw value from the database.

impl<'r, T> Decode<'r, Sqlite> for Json<T>

where T: 'r + Deserialize<'r>,

fn decode( value: SqliteValueRef<'r>, ) -> Result<Json<T>, Box<dyn Error + Sync + Send>>

Decode a new value of this type using a raw value from the database.

impl<T> Default for Json<T>

where T: Default + ?Sized,

fn default() -> Json<T>

Returns the “default value” for a type.

impl<T> Deref for Json<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &<Json<T> as Deref>::Target

Dereferences the value.

impl<T> DerefMut for Json<T>

fn deref_mut(&mut self) -> &mut <Json<T> as Deref>::Target

Mutably dereferences the value.

impl<'de, T> Deserialize<'de> for Json<T>

where T: Deserialize<'de> + ?Sized,

fn deserialize<__D>( __deserializer: __D, ) -> Result<Json<T>, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

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

where T: Serialize,

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

Writes the value of self into buf without moving self.

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

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

where T: Serialize,

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

Writes the value of self into buf without moving self.

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

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

where T: Serialize,

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

Writes the value of self into buf without moving self.

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

impl<T> From<T> for Json<T>

fn from(value: T) -> Json<T>

Converts to this type from the input type.

impl<T> Hash for Json<T>

where T: Hash + ?Sized,

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

impl<T> Ord for Json<T>

where T: Ord + ?Sized,

fn cmp(&self, other: &Json<T>) -> Ordering

This method returns an Ordering between self and other.

impl<T> PartialEq for Json<T>

where T: PartialEq + ?Sized,

fn eq(&self, other: &Json<T>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T> PartialOrd for Json<T>

where T: PartialOrd + ?Sized,

fn partial_cmp(&self, other: &Json<T>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T> PgHasArrayType for Json<T>

fn array_type_info() -> PgTypeInfo

fn array_compatible(ty: &PgTypeInfo) -> bool

impl<T> Serialize for Json<T>

where T: Serialize + ?Sized,

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T> Type<MySql> for Json<T>

fn type_info() -> MySqlTypeInfo

Returns the canonical SQL type for this Rust type.

fn compatible(ty: &MySqlTypeInfo) -> bool

Determines if this Rust type is compatible with the given SQL type.

impl<T> Type<Postgres> for Json<T>

fn type_info() -> PgTypeInfo

Returns the canonical SQL type for this Rust type.

fn compatible(ty: &PgTypeInfo) -> bool

Determines if this Rust type is compatible with the given SQL type.

impl<T> Type<Sqlite> for Json<T>

fn type_info() -> SqliteTypeInfo

Returns the canonical SQL type for this Rust type.

fn compatible(ty: &SqliteTypeInfo) -> bool

Determines if this Rust type is compatible with the given SQL type.

impl<T> Copy for Json<T>

where T: Copy + ?Sized,

impl<T> Eq for Json<T>

where T: Eq + ?Sized,

impl<T> StructuralPartialEq for Json<T>

where T: ?Sized,