Struct Element

pub struct Element<'buf> { /* private fields */ }

A JSON Element composed of a Path and it’s [Value].

The Span is included so that the Element’s source &str can be acquired from the source JSON if needed.

Implementations

impl<'buf> Element<'buf>

pub fn id(&self) -> ElemId

Return the unique Id for this Element.

pub fn path(&self) -> PathRef<'buf>

Return the Path to this Element.

Examples found in repository

examples/price_cdr_with_unknown_version.rs (line 89)

fn print_timezone_warnings(
    cdr: &cdr::Versioned<'_>,
    warnings: &warning::Report<timezone::WarningKind>,
) {
    if warnings.is_empty() {
        return;
    }

    eprintln!("WARN: {} warnings from the timezone search", warnings.len());

    for warning::ElementReport { element, warnings } in warnings.iter(cdr.as_element()) {
        eprintln!(
            "Warnings reported for `json::Element` at path: `{}`",
            element.path()
        );

        for warning in warnings {
            eprintln!("  * {warning}");
        }

        eprintln!();
    }
}

examples/lint_tariff.rs (line 42)

fn print_lint_warnings(
    tariff: &tariff::Versioned<'_>,
    warnings: &warning::Report<lint::tariff::WarningKind>,
) {
    if warnings.is_empty() {
        return;
    }

    eprintln!("WARN: {} warnings from the linting", warnings.len());

    for warning::ElementReport { element, warnings } in warnings.iter(tariff.as_element()) {
        eprintln!(
            "Warnings reported for `json::Element` at path: `{}`",
            element.path()
        );

        for warning in warnings {
            eprintln!("  * {warning}");
        }

        eprintln!();
    }
}

pub fn source_json(&self, source_json: &'buf str) -> SourceStr<'buf>

Return the source JSON &str of the entire Object field if the Element is an Object. Otherwise return the span of the [Value].

In the case of an array like ["one", "two"], calling this method on the second Element will return "two".

In the case of an object like {"one": 1, "two": 2}, calling this method on the second Element will return "\"two\": 2".

Panics

If a source JSON is used that this Element didn’t not originate from there is a chance that this function will panic.

pub fn source_json_value(&self, source_json: &'buf str) -> &'buf str

Return the source JSON &str for the [Value].

In the case of an array like ["one", "two"], calling this method on the second Element will return "two".

In the case of an object like {"one": 1, "two": 2}, calling this method on the second Element will return "2".

Panics

If a source JSON is used that this Element didn’t not originate from there is a chance that this function will panic.

Trait Implementations

impl<'buf> Debug for Element<'buf>

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

Formats the value using the given formatter.

impl Display for Element<'_>

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

Formats the value using the given formatter.

impl Ord for Element<'_>

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<'buf> PartialEq for Element<'buf>

fn eq(&self, other: &Element<'buf>) -> 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 Element<'_>

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<'buf> Eq for Element<'buf>

impl<'buf> StructuralPartialEq for Element<'buf>