Struct Json

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

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 + ?Sized> Clone for Json<T>

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 + ?Sized> Debug for Json<T>

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

Formats the value using the given formatter.

impl<T: Default + ?Sized> Default for Json<T>

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) -> &Self::Target

Dereferences the value.

impl<T> DerefMut for Json<T>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

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

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

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

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

fn from(value: T) -> Self

Converts to this type from the input type.

impl<T: Hash + ?Sized> Hash for Json<T>

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

Feeds this value into the given Hasher.

impl<T: Ord + ?Sized> Ord for Json<T>

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

This method returns an Ordering between self and other.

impl<T: PartialEq + ?Sized> PartialEq for Json<T>

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 + ?Sized> PartialOrd for Json<T>

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> Serialize for Json<T>

where T: Serialize + ?Sized,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T: Copy + ?Sized> Copy for Json<T>

impl<T: Eq + ?Sized> Eq for Json<T>

impl<T: ?Sized> StructuralPartialEq for Json<T>