Struct RawJson

pub struct RawJson<'text> { /* private fields */ }

Parsed JSON text (syntactically correct, but not yet converted to Rust types).

This struct holds a JSON text in its original form (i.e., JSON integers are not converted to Rust’s integers), while ensuring the text is valid JSON syntax.

RawJson maintains index information about each JSON value in the text, including its type (JsonValueKind) and the start and end byte positions. You can traverse the JSON structure by accessing the top-level value via RawJson::value(), which returns a RawJsonValue that provides methods to explore nested elements and convert them into Rust types.

Note that, for simple use cases, using Json, which internally uses RawJson, is a more convenient way to parse JSON text into Rust types.

Implementations

impl<'text> RawJson<'text>

pub fn parse(text: &'text str) -> Result<Self, JsonParseError>

Parses a JSON string into a RawJson instance.

This validates the JSON syntax without converting values to Rust types.

Example

let text = r#"{"name": "John", "age": 30}"#;
let json = RawJson::parse(text)?;

pub fn text(&self) -> &'text str

Returns the original JSON text.

pub fn value(&self) -> RawJsonValue<'text, '_>

Returns the top-level value of the JSON.

This value can be used as an entry point to traverse the entire JSON structure and convert it to Rust types.

Example

let text = r#"{"name": "John", "age": 30}"#;
let json = RawJson::parse(text).unwrap();
let value = json.value();

pub fn get_value_by_position( &self, position: usize, ) -> Option<RawJsonValue<'text, '_>>

Finds the JSON value at the specified byte position in the original text.

This method traverses the JSON structure to find the most specific value that contains the given position. It returns None if the position is outside the bounds of the JSON text.

This method is useful for retrieving the context where a JsonParseError::InvalidValue error occurred.

Example

let json = RawJson::parse(r#"{"name": "John", "age": 30}"#)?;

// Position at "name" key
let name_value = json.get_value_by_position(2).expect("infallible");
assert_eq!(name_value.as_raw_str(), r#""name""#);

// Position at number value
let age_value = json.get_value_by_position(25).expect("infallible");
assert_eq!(age_value.as_raw_str(), "30");

Trait Implementations

impl<'text> Clone for RawJson<'text>

fn clone(&self) -> RawJson<'text>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'text> Debug for RawJson<'text>

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

Formats the value using the given formatter.

impl Display for RawJson<'_>

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

Formats the value using the given formatter.

impl DisplayJson for RawJson<'_>

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

Formats the value as JSON into the provided formatter.

impl Hash for RawJson<'_>

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 RawJson<'_>

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 RawJson<'_>

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 RawJson<'_>

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 RawJson<'_>