Struct EureDocument 

pub struct EureDocument { /* private fields */ }

Implementations

impl EureDocument

pub fn new() -> Self

pub fn new_empty() -> Self

pub fn new_primitive(value: PrimitiveValue) -> Self

pub fn root(&self) -> &Node

pub fn get_root_id(&self) -> NodeId

pub fn node(&self, id: NodeId) -> &Node

pub fn get_node(&self, id: NodeId) -> Option<&Node>

pub fn node_mut(&mut self, id: NodeId) -> &mut Node

pub fn get_node_mut(&mut self, id: NodeId) -> Option<&mut Node>

pub fn create_node(&mut self, new: NodeValue) -> NodeId

pub fn create_node_uninitialized(&mut self) -> NodeId

pub fn set_content(&mut self, node_id: NodeId, content: NodeValue)

Set the content of a node directly

pub fn add_child_by_segment( &mut self, segment: PathSegment, parent_node_id: NodeId, ) -> Result<NodeMut<'_>, InsertErrorKind>

pub fn add_map_child( &mut self, object_key: ObjectKey, parent_node_id: NodeId, ) -> Result<NodeMut<'_>, InsertErrorKind>

pub fn add_extension( &mut self, identifier: Identifier, parent_node_id: NodeId, ) -> Result<NodeMut<'_>, InsertErrorKind>

pub fn add_tuple_element( &mut self, index: u8, parent_node_id: NodeId, ) -> Result<NodeMut<'_>, InsertErrorKind>

pub fn add_array_element( &mut self, index: Option<usize>, parent_node_id: NodeId, ) -> Result<NodeMut<'_>, InsertErrorKind>

pub fn resolve_child_by_segment( &mut self, segment: PathSegment, parent_node_id: NodeId, ) -> Result<NodeMut<'_>, InsertErrorKind>

Resolves a path segment to a node ID, creating if necessary.

This operation is idempotent for most segments, reusing existing nodes. Exception: ArrayIndex(None) always creates a new array element (push operation).

pub fn node_subtree_to_document(&self, node_id: NodeId) -> EureDocument

Convert a subtree of a document to a standalone document.

pub fn copy_subtree( &self, src_id: NodeId, dst: &mut EureDocument, dst_id: NodeId, )

impl EureDocument

Commands

pub fn replace_with_primitive( &mut self, value: PrimitiveValue, ) -> Result<(), InsertErrorKind>

pub fn reset_as_map(&mut self) -> Result<(), InsertErrorKind>

impl<'doc> EureDocument

pub fn parse<T: ParseDocument<'doc>>( &'doc self, node_id: NodeId, ) -> Result<T, T::Error>

Parse a value of type T from the given node.

pub fn parse_with<T: DocumentParser<'doc>>( &'doc self, node_id: NodeId, parser: T, ) -> Result<T::Output, T::Error>

pub fn parse_context(&'doc self, node_id: NodeId) -> ParseContext<'doc>

Create a parse context at the given node.

pub fn parse_record( &'doc self, node_id: NodeId, ) -> Result<RecordParser<'doc>, ParseError>

Parse a node as a record.

Convenience method equivalent to doc.parse_context(node_id).parse_record().

pub fn parse_extension_context( &'doc self, node_id: NodeId, ) -> ParseContext<'doc>

Create a parse context for extension parsing.

Convenience method equivalent to doc.parse_context(node_id). Use the returned context’s parse_ext(), ext(), etc. methods.

pub fn parse_tuple( &'doc self, node_id: NodeId, ) -> Result<TupleParser<'doc>, ParseError>

Parse a node as a tuple.

Convenience method equivalent to doc.parse_context(node_id).parse_tuple().

Trait Implementations

impl Clone for EureDocument

fn clone(&self) -> EureDocument

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EureDocument

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

Formats the value using the given formatter.

impl Default for EureDocument

fn default() -> Self

Returns the “default value” for a type.

impl<'doc> ParseDocument<'doc> for EureDocument

type Error = ParseError

The error type returned by parsing.

fn parse(ctx: &ParseContext<'doc>) -> Result<Self, Self::Error>

Parse a value of this type from the given parse context.

impl PartialEq for EureDocument

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.