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 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<u8>.

Returns

The underlying Vec<u8> containing the JSONB data.

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) -> Self

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

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.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for OwnedJsonb

fn eq(&self, other: &Self) -> bool

Equality operator ==.

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

Inequality operator !=.

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.