Struct OwnedJsonb 

pub struct OwnedJsonb { /* private fields */ }

Represents a JSONB data that owns its underlying data.

This struct provides ownership over the binary JSONB representation. OwnedJsonb is primarily used to create JSONB data from other data types (such as JSON String). However, for most operations, it’s necessary to convert an OwnedJsonb to a RawJsonb using the as_raw() method to avoid unnecessary copying and to take advantage of the performance benefits of the read-only access of the RawJsonb.

Implementations

impl OwnedJsonb

pub fn new(data: Vec<u8>) -> OwnedJsonb

Creates a new OwnedJsonb from a Vec.

Arguments

• data - The Vec<u8> containing the JSONB data.

Returns

A new OwnedJsonb instance.

pub fn as_raw(&self) -> RawJsonb<'_>

Creates a RawJsonb view of the owned data. This is useful for passing the data to functions that expect a RawJsonb. This does not transfer ownership.

Returns

A RawJsonb instance referencing the owned data.

pub fn to_vec(self) -> Vec<u8>

Consumes the OwnedJsonb and returns the underlying Vec.

Returns

The underlying Vec<u8> containing the JSONB data.

pub fn is_empty(&self) -> bool

Checks if the JSONB data is empty.

Returns

true if the data is empty, false otherwise.

pub fn len(&self) -> usize

Returns the length of the JSONB data in bytes.

Returns

The length of the data in bytes.

pub fn build_array<'a>( raw_jsonbs: impl IntoIterator<Item = RawJsonb<'a>>, ) -> Result<OwnedJsonb, Error>

Builds a JSONB array from a collection of RawJsonb values.

This function constructs a new JSONB array from an iterator of RawJsonb values. The resulting OwnedJsonb represents the binary encoding of the array.

Arguments

• items - An iterator of RawJsonb values representing the elements of the array.

Returns

• Ok(OwnedJsonb) - The newly created JSONB array.
• Err(Error) - If any of the input RawJsonb values are invalid or if an error occurs during array construction.

Examples

use jsonb::OwnedJsonb;
use jsonb::RawJsonb;

// Create some RawJsonb values
let owned_num = "1".parse::<OwnedJsonb>().unwrap();
let owned_str = r#""hello""#.parse::<OwnedJsonb>().unwrap();
let owned_arr = "[1,2,3]".parse::<OwnedJsonb>().unwrap();

// Build the array
let raw_jsonbs = vec![owned_num.as_raw(), owned_str.as_raw(), owned_arr.as_raw()];
let array_result = OwnedJsonb::build_array(raw_jsonbs.into_iter());
assert!(array_result.is_ok());
let array = array_result.unwrap();

// Convert to string for easy verification
assert_eq!(array.to_string(), "[1,\"hello\",[1,2,3]]");

// Example with an empty iterator
let empty_array =
    OwnedJsonb::build_array(<[RawJsonb<'_>; 0] as IntoIterator>::into_iter([])).unwrap();
assert_eq!(empty_array.to_string(), "[]");

// Example with invalid input (this will cause an error)
let invalid_data = OwnedJsonb::new(vec![1, 2, 3, 4]);
let result = OwnedJsonb::build_array([invalid_data.as_raw()].into_iter());
assert!(result.is_err());

pub fn build_object<'a, K: AsRef<str>>( items: impl IntoIterator<Item = (K, RawJsonb<'a>)>, ) -> Result<OwnedJsonb, Error>

Builds a JSONB object from a collection of key-value pairs.

This function constructs a new JSONB object from an iterator of key-value pairs. The keys are strings, and the values are RawJsonb values. The resulting OwnedJsonb represents the binary encoding of the object.

Arguments

• items - An iterator of (K, &'a RawJsonb<'a>) tuples, where K is a type that can be converted into a string slice (AsRef<str>) representing the key, and the second element is a RawJsonb representing the value.

Returns

• Ok(OwnedJsonb) - The newly created JSONB object.
• Err(Error) - If any of the input RawJsonb values are invalid, if contain duplicate keys, or if an error occurs during object construction.

Examples

use jsonb::OwnedJsonb;
use jsonb::RawJsonb;

// Create some RawJsonb values
let owned_num = "1".parse::<OwnedJsonb>().unwrap();
let owned_str = r#""hello""#.parse::<OwnedJsonb>().unwrap();
let owned_arr = "[1,2,3]".parse::<OwnedJsonb>().unwrap();

// Build the object
let raw_jsonbs = vec![
    ("a", owned_num.as_raw()),
    ("b", owned_str.as_raw()),
    ("c", owned_arr.as_raw()),
];
let object_result = OwnedJsonb::build_object(raw_jsonbs.into_iter());
assert!(object_result.is_ok());
let object = object_result.unwrap();

// Convert to string for easy verification
assert_eq!(object.to_string(), r#"{"a":1,"b":"hello","c":[1,2,3]}"#);

// Example with an empty iterator
let empty_object =
    OwnedJsonb::build_object(<[(&str, RawJsonb<'_>); 0] as IntoIterator>::into_iter([]))
        .unwrap();
assert_eq!(empty_object.to_string(), "{}");

// Example with invalid value
let invalid_data = OwnedJsonb::new(vec![1, 2, 3, 4]);
let result = OwnedJsonb::build_object([("a", invalid_data.as_raw())].into_iter());
assert!(result.is_err());

Trait Implementations

impl AsRef<[u8]> for OwnedJsonb

Allows accessing the underlying byte slice as a reference. This enables easy integration with functions that expect a &[u8].

fn as_ref(&self) -> &[u8]

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

impl Clone for OwnedJsonb

fn clone(&self) -> OwnedJsonb

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OwnedJsonb

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

Formats the value using the given formatter.

impl Display for OwnedJsonb

Implements the Display trait, allowing OwnedJsonb to be formatted as a string using the {} format specifier.

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

Formats the value using the given formatter.

impl From<&[u8]> for OwnedJsonb

Creates an OwnedJsonb from a borrowed byte slice. The byte slice is copied into a new Vec<u8>.

fn from(data: &[u8]) -> Self

Converts to this type from the input type.

impl From<Vec<u8>> for OwnedJsonb

Creates an OwnedJsonb from a Vec<u8>. This is a simple ownership transfer.

fn from(data: Vec<u8>) -> Self

Converts to this type from the input type.

impl FromStr for OwnedJsonb

Parses a string into an OwnedJsonb. The string is parsed into a JSON value, then encoded into the binary JSONB format.

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Ord for OwnedJsonb

Implements Ord for OwnedJsonb, allowing comparison of two OwnedJsonb values using the total ordering. This implementation leverages the PartialOrd implementation, returning Ordering::Equal for incomparable values.

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 PartialEq for OwnedJsonb

fn eq(&self, other: &Self) -> 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 OwnedJsonb

Implements PartialOrd for OwnedJsonb, allowing comparison of two OwnedJsonb values.

The comparison logic handles different JSONB types (scalar, array, object) and considers null values. The ordering is defined as follows:

1. Null is considered greater than any other type.
2. Scalars are compared based on their type and value (String > Number > Boolean).
3. Arrays are compared element by element.
4. Objects are compared based on their keys and values.
5. Arrays are greater than objects and scalars.
6. Objects are greater than scalars.
7. If the types are incompatible, None is returned.

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 Eq for OwnedJsonb