Enum Structural

pub enum Structural {
    Closing(BracketType, usize),
    Colon(usize),
    Opening(BracketType, usize),
    Comma(usize),
}

Defines structural characters in JSON documents.

Variants

Closing(BracketType, usize)

Represents the closing square or curly brace, ‘]’ or ‘}’.

Colon(usize)

Represents the colon ‘:’ character.

Opening(BracketType, usize)

Represents the opening square or curly brace, ‘[’ or ‘{’.

Comma(usize)

Represents the comma ‘,’ character.

Implementations

impl Structural

pub fn idx(self) -> usize

Returns the index of the character in the document, i.e. which byte it is counting from 0.

pub fn offset(self, amount: usize) -> Self

Add a given amount to the structural’s index.

Examples

let structural = Structural::Colon(42);
let offset_structural = structural.offset(10);

assert_eq!(structural.idx(), 42);
assert_eq!(offset_structural.idx(), 52);

pub fn is_closing(&self) -> bool

Check if the structural represents a closing character, i.e. a Closing with either of the BracketType variants.

Examples

let brace = Structural::Closing(BracketType::Curly, 42);
let bracket = Structural::Closing(BracketType::Square, 43);
let neither = Structural::Comma(44);

assert!(brace.is_closing());
assert!(bracket.is_closing());
assert!(!neither.is_closing());

pub fn is_opening(&self) -> bool

Check if the structural represents an opening character, i.e. an Opening with either of the BracketType variants.

Examples

let brace = Structural::Opening(BracketType::Curly, 42);
let bracket = Structural::Opening(BracketType::Square, 43);
let neither = Structural::Comma(44);

assert!(brace.is_opening());
assert!(bracket.is_opening());
assert!(!neither.is_opening());

Trait Implementations

impl Clone for Structural

fn clone(&self) -> Structural

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Structural

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

Formats the value using the given formatter.

impl Hash for Structural

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

fn eq(&self, other: &Structural) -> 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 Copy for Structural

impl Eq for Structural

impl StructuralPartialEq for Structural