Struct SourceMap 

pub struct SourceMap { /* private fields */ }

Byte spans of every node object in a JSON text, addressable by index path and by offset.

Build cost is O(text); span is O(depth) and path_at is O(log nodes + depth).

use tiptap_rusty_parser::{Document, SourceMap};

let doc = Document::from_json_str(
    r#"{"type":"doc","content":[{"type":"callout","x":1,"content":[{"type":"text","text":"hi"}]}]}"#,
).unwrap();
let (text, map) = SourceMap::pretty(doc.root());
let span = map.span(&[0, 0]).unwrap();
assert!(text[span.clone()].contains("\"hi\""));
// Any byte inside the text node resolves back to it.
assert_eq!(map.path_at(span.start + 3), Some(vec![0, 0]));

Implementations

impl SourceMap

pub fn build(text: &str) -> Result<SourceMap, SourceMapError>

Scan text (a JSON node object, any formatting).

pub fn pretty(node: &Node) -> (String, SourceMap)

Serialize node with serde_json pretty formatting (the same text as Document::to_string_pretty) and map it.

pub fn len(&self) -> usize

Number of node objects.

pub fn is_empty(&self) -> bool

Whether no node was mapped (only for SourceMap::default()).

pub fn span(&self, path: &[usize]) -> Option<Range<usize>>

Byte range of the node object at path ({ through }), or None when the path does not resolve.

pub fn child_count(&self, path: &[usize]) -> Option<usize>

Number of children of the node at path.

pub fn path_at(&self, offset: usize) -> Option<Vec<usize>>

Path of the deepest node whose span contains byte offset, or None when offset lies outside the root object.

Trait Implementations

impl Clone for SourceMap

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 SourceMap

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

Formats the value using the given formatter.

impl Default for SourceMap

fn default() -> Self

Returns the “default value” for a type.