Struct kg_tree::NodeRef

pub struct NodeRef(_);

Methods

impl NodeRef

pub fn null() -> NodeRef

pub fn boolean(b: bool) -> NodeRef

pub fn integer(n: i64) -> NodeRef

pub fn float(n: f64) -> NodeRef

pub fn string<S: Into<String>>(s: S) -> NodeRef

pub fn binary<B: Into<Vec<u8>>>(b: B) -> NodeRef

pub fn array(elems: Elements) -> NodeRef

pub fn object(props: Properties) -> NodeRef

pub fn is_consumable(&self) -> bool

pub fn into_consumable(self) -> NodeRef

pub fn from_type<T>(value: T) -> Result<NodeRef, Error> where
    T: Serialize, 

pub fn from_json(s: &str) -> Result<NodeRef, ParseDiag>

pub fn from_yaml(s: &str) -> Result<NodeRef, ParseDiag>

pub fn from_toml(s: &str) -> Result<NodeRef, ParseDiag>

pub fn from_str(s: Cow<str>, format: FileFormat) -> Result<NodeRef, BasicDiag>

pub fn from_bytes(s: &[u8], format: FileFormat) -> Result<NodeRef, BasicDiag>

pub fn from_file(
    file_path: &Path,
    format: Option<FileFormat>
) -> Result<NodeRef, BasicDiag>

pub fn to_type<'de, T>(&self) -> Result<T, Error> where
    T: Deserialize<'de>, 

pub fn to_json(&self) -> String

pub fn to_json_pretty(&self) -> String

pub fn to_yaml(&self) -> String

pub fn to_toml(&self) -> String

pub fn to_format(&self, format: FileFormat, pretty: bool) -> String

pub fn data(&self) -> Ref<Node>

pub fn data_mut(&self) -> RefMut<Node>

pub fn data_ptr(&self) -> *const Node

pub fn path(&self) -> Opath

pub fn into_string(self) -> String

pub fn as_string(&self) -> String

pub fn as_integer(&self) -> Option<i64>

pub fn as_float(&self) -> f64

pub fn as_binary(&self) -> Option<Vec<u8>>

pub fn as_boolean(&self) -> bool

pub fn is_integer(&self) -> bool

pub fn is_float(&self) -> bool

pub fn is_number(&self) -> bool

pub fn is_object(&self) -> bool

pub fn is_string(&self) -> bool

pub fn is_array(&self) -> bool

pub fn is_binary(&self) -> bool

pub fn is_boolean(&self) -> bool

pub fn is_null(&self) -> bool

pub fn is_parent(&self) -> bool

pub fn get_child_index(&self, index: usize) -> Option<NodeRef>

pub fn get_child_key(&self, key: &str) -> Option<NodeRef>

pub fn add_child(
    &self,
    index: Option<usize>,
    key: Option<Symbol>,
    value: NodeRef
) -> Result<Option<NodeRef>, BasicDiag>

pub fn set_child(
    &self,
    index: Option<usize>,
    key: Option<Symbol>,
    value: NodeRef
) -> Result<Option<NodeRef>, BasicDiag>

pub fn add_children<'a, I>(
    &self,
    drop: bool,
    items: I
) -> Result<Vec<NodeRef>, BasicDiag> where
    I: Iterator<Item = (Option<usize>, Option<Symbol>, NodeRef)>, 

pub fn remove_child(
    &self,
    index: Option<usize>,
    key: Option<Cow<str>>
) -> Result<Option<NodeRef>, BasicDiag>

pub fn remove_children<'a, I>(
    &self,
    drop: bool,
    items: I
) -> Result<Vec<NodeRef>, TreeErrorDetail> where
    I: Iterator<Item = (Option<usize>, Option<Cow<'a, str>>)>, 

pub fn extend(&self, o: NodeRef, index: Option<usize>) -> Result<(), BasicDiag>

pub fn extend_multiple<I>(&self, extends: I) -> Result<(), BasicDiag> where
    I: Iterator<Item = (NodeRef, Option<usize>)>, 

pub fn is_ref_eq(&self, other: &NodeRef) -> bool

pub fn deep_copy(&self) -> NodeRef

pub fn visit_recursive<F>(&self, visitor: F) where
    F: FnMut(&NodeRef, &NodeRef, &NodeRef) -> bool, 

pub fn visit_children<F>(&self, visitor: F) -> bool where
    F: FnMut(&NodeRef, &NodeRef) -> bool, 

pub fn heap_size(&self) -> usize

pub fn is_equal(&self, other: &NodeRef) -> bool

pub fn is_identical(&self, other: &NodeRef) -> bool

pub fn is_identical_deep(&self, other: &NodeRef) -> bool

pub fn with_span(self, span: Span) -> NodeRef

Trait Implementations

impl<'a> Clone for NodeRef

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl From<NodeRef> for NodeSet

fn from(node: NodeRef) -> Self

Performs the conversion.

impl<'a> PartialOrd<NodeRef> for NodeRef

fn partial_cmp(&self, other: &NodeRef) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use] fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use] fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use] fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use] fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<'a> PartialEq<NodeRef> for NodeRef

fn eq(&self, other: &NodeRef) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'a> Display for NodeRef

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

Formats the value using the given formatter.

impl Debug for NodeRef

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

Formats the value using the given formatter.

impl<'a> HeapSizeOf for NodeRef

fn heap_size_of_children(&self) -> usize

Measure the size of any heap-allocated structures that hang off this value, but not the space taken up by the value itself (i.e. what size_of:: measures, more or less); that space is handled by the implementation of HeapSizeOf for Box below.

impl<'a> Serialize for NodeRef

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where
    S: Serializer, 

Serialize this value into the given Serde serializer.

impl<'de> Deserialize<'de> for NodeRef

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where
    D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.