Struct JsonbRef 

pub struct JsonbRef<'a>(pub(crate) ValueRef<'a>);

Tuple Fields

0: ValueRef<'a>

Implementations

impl<'a> JsonbRef<'a>

pub fn memcmp_serialize( &self, serializer: &mut Serializer<impl BufMut>, ) -> Result<()>

pub fn value_serialize(&self) -> Vec<u8>

Serialize to a pgwire “BINARY” encoding.

pub const fn null() -> Self

Returns a jsonb null value.

pub fn is_jsonb_null(&self) -> bool

Returns true if this is a jsonb null.

pub fn is_scalar(&self) -> bool

Returns true if this is a jsonb null, boolean, number or string.

pub fn is_array(&self) -> bool

Returns true if this is a jsonb array.

pub fn is_object(&self) -> bool

Returns true if this is a jsonb object.

pub fn type_name(&self) -> &'static str

Returns the type name of this jsonb.

Possible values are: null, boolean, number, string, array, object.

pub fn array_len(&self) -> Result<usize, String>

Returns the length of this json array.

pub fn as_bool(&self) -> Result<bool, String>

If the JSON is a boolean, returns the associated bool.

pub fn as_string(&self) -> Result<String, String>

If the JSON is a string, returns the associated string.

pub fn as_str(&self) -> Result<&str, String>

If the JSON is a string, returns the associated &str.

pub fn as_number(&self) -> Result<F64, String>

Attempt to read jsonb as a JSON number.

According to RFC 8259, only number within IEEE 754 binary64 (double precision) has good interoperability. We do not support arbitrary precision like PostgreSQL numeric right now.

pub fn force_str<W: Write>(&self, writer: &mut W) -> Result

This is part of the ->> or #>> syntax to access a child as string.

• It is not as_str, because there is no runtime error when the jsonb type is not string.
• It is not same as std::fmt::Display or super::ToText (cast to string) in the following 2 cases:
  • Jsonb null is displayed as 4-letter null but treated as sql null here.
    • This function writes nothing and the caller is responsible for checking Self::is_jsonb_null to differentiate it from an empty string.
  • Jsonb string is displayed with quotes but treated as its inner value here.

pub fn force_string(&self) -> String

pub fn access_object_field(&self, field: &str) -> Option<Self>

pub fn access_array_element(&self, idx: usize) -> Option<Self>

pub fn array_elements( self, ) -> Result<impl Iterator<Item = JsonbRef<'a>>, String>

Returns an iterator over the elements if this is an array.

pub fn object_keys(self) -> Result<impl Iterator<Item = &'a str>, String>

Returns an iterator over the keys if this is an object.

pub fn object_key_values( self, ) -> Result<impl Iterator<Item = (&'a str, JsonbRef<'a>)>, String>

Returns an iterator over the key-value pairs if this is an object.

pub fn pretty(self, f: &mut impl Write) -> Result

Pretty print the jsonb value to the given writer, with 4 spaces indentation.

pub fn to_datum(self, ty: &DataType) -> Result<Datum, String>

Convert the jsonb value to a datum.

pub fn to_list(self, ty: &ListType) -> Result<ListValue, String>

Convert the jsonb value to a list value.

pub fn to_struct(self, ty: &StructType) -> Result<StructValue, String>

Convert the jsonb value to a struct value.

pub fn to_map(self, ty: &MapType) -> Result<MapValue, String>

pub fn populate_struct( self, ty: &StructType, base: Option<StructRef<'_>>, ) -> Result<StructValue, String>

Expands the top-level JSON object to a row having the struct type of the base argument.

pub fn capacity(self) -> usize

Returns the capacity of the underlying buffer.

Trait Implementations

impl<'a> Clone for JsonbRef<'a>

fn clone(&self) -> JsonbRef<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for JsonbRef<'a>

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

Formats the value using the given formatter.

impl Display for JsonbRef<'_>

The display of JsonbRef is pg-compatible format which has slightly different from serde_json::Value.

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

Formats the value using the given formatter.

impl From<JsonbRef<'_>> for JsonbVal

fn from(v: JsonbRef<'_>) -> Self

Converts to this type from the input type.

impl From<JsonbRef<'_>> for ScalarImpl

fn from(jsonb: JsonbRef<'_>) -> Self

Converts to this type from the input type.

impl<'a> From<JsonbRef<'a>> for ValueRef<'a>

fn from(v: JsonbRef<'a>) -> Self

Converts to this type from the input type.

impl<'scalar> From<JsonbRef<'scalar>> for ScalarRefImpl<'scalar>

fn from(val: JsonbRef<'scalar>) -> Self

Converts to this type from the input type.

impl<'a> Hash for JsonbRef<'a>

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

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for JsonbRef<'_>

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<'a> PartialEq for JsonbRef<'a>

fn eq(&self, other: &JsonbRef<'a>) -> 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 PartialOrd for JsonbRef<'_>

fn partial_cmp(&self, other: &Self) -> 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<'a> ScalarRef<'a> for JsonbRef<'a>

type ScalarType = JsonbVal

ScalarType is the owned type of current ScalarRef.

fn to_owned_scalar(&self) -> Self::ScalarType

Convert ScalarRef to an owned scalar.

fn hash_scalar<H: Hasher>(&self, state: &mut H)

A wrapped hash function to get the hash value for this scaler.

impl SelfAsScalarRef for JsonbRef<'_>

fn as_scalar_ref(&self) -> Self

impl ToBinary for JsonbRef<'_>

fn to_binary_with_type(&self, _ty: &DataType) -> Result<Bytes, ToBinaryError>

impl ToSql for JsonbRef<'_>

fn accepts(ty: &Type) -> bool

Determines if a value of this type can be converted to the specified Postgres Type.

fn to_sql_checked( &self, ty: &Type, out: &mut BytesMut, ) -> Result<IsNull, Box<dyn Error + Sync + Send>>

An adaptor method used internally by Rust-Postgres.

fn to_sql( &self, ty: &Type, out: &mut BytesMut, ) -> Result<IsNull, Box<dyn Error + Sync + Send>>

where Self: Sized,

Converts the value of self into the binary format of the specified Postgres Type, appending it to out.

fn encode_format(&self, _ty: &Type) -> Format

Specify the encode format

impl ToText for JsonbRef<'_>

fn write<W: Write>(&self, f: &mut W) -> Result

Write the text to the writer regardless of its data type

fn write_with_type<W: Write>(&self, _ty: &DataType, f: &mut W) -> Result

Write the text to the writer according to its data type

fn to_text_with_type(&self, ty: &DataType) -> String

Convert to text according to its data type

fn to_text(&self) -> String

to_text is a special version of to_text_with_type, it convert the scalar to default type text. E.g. for Int64, it will convert to text as a Int64 type. We should prefer to use to_text_with_type because it’s more clear and readable.

fn text_display(&self) -> impl Display + '_

Returns an displayable wrapper implemented with ToText::write.

impl<'scalar> TryFrom<ScalarRefImpl<'scalar>> for JsonbRef<'scalar>

type Error = ArrayError

The type returned in the event of a conversion error.

fn try_from(val: ScalarRefImpl<'scalar>) -> ArrayResult<Self>

Performs the conversion.

impl WithDataType for JsonbRef<'_>

fn default_data_type() -> DataType

Returns the most obvious DataType for the rust type.

impl<'a> Copy for JsonbRef<'a>

impl<'a> Eq for JsonbRef<'a>

impl<'a> StructuralPartialEq for JsonbRef<'a>