Struct JSON 

pub struct JSON(/* private fields */);

A CBOR-tagged container for UTF-8 JSON text.

The JSON type wraps UTF-8 JSON text as a CBOR byte string with tag 262. This allows JSON data to be embedded within CBOR structures while maintaining type information through the tag.

This implementation does not validate that the contained data is well-formed JSON. It simply provides a type-safe wrapper around byte data that is intended to contain JSON text.

CBOR Serialization

JSON implements the CBORTaggedCodable trait, which means it can be serialized to and deserialized from CBOR with tag 262 (TAG_JSON).

Examples

Creating JSON from a string:

use bc_components::JSON;

let json = JSON::from_string(r#"{"key": "value"}"#);
assert_eq!(json.as_str(), r#"{"key": "value"}"#);

Creating JSON from bytes:

use bc_components::JSON;

let json = JSON::from_data(b"[1, 2, 3]");
assert_eq!(json.len(), 9);

Implementations

impl JSON

pub fn len(&self) -> usize

Return the length of the JSON data in bytes.

pub fn is_empty(&self) -> bool

Return true if the JSON data is empty.

pub fn from_data(data: impl AsRef<[u8]>) -> Self

Create a new JSON instance from byte data.

pub fn from_string(s: impl AsRef<str>) -> Self

Create a new JSON instance from a string.

pub fn as_bytes(&self) -> &[u8]

Return the data as a byte slice.

pub fn as_str(&self) -> &str

Return the data as a UTF-8 string slice.

Panics

Panics if the data is not valid UTF-8.

pub fn from_hex(hex: impl AsRef<str>) -> Self

Create a new JSON instance from a hexadecimal string.

pub fn hex(&self) -> String

Return the data as a hexadecimal string.

Trait Implementations

impl AsRef<[u8]> for JSON

Allows using a JSON as a reference to a byte slice.

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

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

impl AsRef<JSON> for JSON

Provides a self-reference, enabling API consistency with other types.

fn as_ref(&self) -> &JSON

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

impl CBORTagged for JSON

Identifies the CBOR tags used for JSON serialization.

fn cbor_tags() -> Vec<Tag>

Returns the CBOR tags associated with this type.

impl CBORTaggedDecodable for JSON

Defines how JSON is decoded from CBOR.

fn from_untagged_cbor(untagged_cbor: CBOR) -> Result<Self>

Creates an instance of this type by decoding it from untagged CBOR.

fn from_tagged_cbor(cbor: CBOR) -> Result<Self, Error>

where Self: Sized,

Creates an instance of this type by decoding it from tagged CBOR.

fn from_tagged_cbor_data(data: impl AsRef<[u8]>) -> Result<Self, Error>

where Self: Sized,

Creates an instance of this type by decoding it from binary encoded tagged CBOR.

fn from_untagged_cbor_data(data: impl AsRef<[u8]>) -> Result<Self, Error>

where Self: Sized,

Creates an instance of this type by decoding it from binary encoded untagged CBOR.

impl CBORTaggedEncodable for JSON

Defines how JSON is encoded as CBOR (as a byte string).

fn untagged_cbor(&self) -> CBOR

Returns the untagged CBOR encoding of this instance.

fn tagged_cbor(&self) -> CBOR

Returns the tagged CBOR encoding of this instance.

fn tagged_cbor_data(&self) -> Vec<u8>

Returns the tagged value in CBOR binary representation.

impl Clone for JSON

fn clone(&self) -> JSON

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for JSON

Provides a debug representation showing the JSON data as a string.

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

Formats the value using the given formatter.

impl<'a> From<&'a JSON> for &'a [u8]

Allows accessing the underlying data as a byte slice reference.

fn from(value: &'a JSON) -> Self

Converts to this type from the input type.

impl From<&JSON> for JSON

Enables cloning a JSON from a reference using From trait.

fn from(json: &JSON) -> Self

Converts to this type from the input type.

impl From<&JSON> for Vec<u8>

Converts a JSON reference into a Vec<u8> containing the JSON bytes.

fn from(json: &JSON) -> Self

Converts to this type from the input type.

impl From<JSON> for CBOR

Enables conversion of JSON into a tagged CBOR value.

fn from(value: JSON) -> Self

Converts to this type from the input type.

impl From<JSON> for Vec<u8>

Converts JSON into a Vec<u8> containing the JSON bytes.

fn from(json: JSON) -> Self

Converts to this type from the input type.

impl PartialEq for JSON

fn eq(&self, other: &JSON) -> 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 TryFrom<CBOR> for JSON

Enables conversion from CBOR to JSON, with proper error handling.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(cbor: CBOR) -> Result<Self>

Performs the conversion.

impl Eq for JSON

impl StructuralPartialEq for JSON