Struct Hierarchical

pub struct Hierarchical { /* private fields */ }

A simple hierarchical storage system for strings.

Implementations

impl Hierarchical

pub fn new<T>( key: T, content: Vec<String>, children: Vec<Hierarchical>, ) -> Hierarchical

where T: Into<String>,

Create a new hierarchical structure.

pub fn key(&self) -> &str

Get the key value.

pub fn key_mut(&mut self) -> &mut String

Get the key mutably.

pub fn content(&self) -> &[String]

Get the content.

pub fn content_mut(&mut self) -> &mut Vec<String>

Get the content mutably.

pub fn push<T>(&mut self, item: T)

where T: Into<String>,

Push a new content item.

pub fn children(&self) -> &[Hierarchical]

Get the children.

pub fn children_mut(&mut self) -> &mut Vec<Hierarchical>

Get the children mutably.

pub fn push_child(&mut self, item: Hierarchical)

Push a child hierarchy.

pub fn to_bytes<E>(self) -> Result<Vec<u8>, Error>

where E: ByteOrder,

Convert the hierarhcy into a byte buffer.

pub fn from_bytes(bytes: &[u8]) -> Result<Hierarchical, Error>

Create a hierarchical structure from the given bytes. TODO: Should probably just give this a reader rather than taking the bytes directly.. Hmmm

Trait Implementations

impl Clone for Hierarchical

fn clone(&self) -> Hierarchical

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Hierarchical

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

Formats the value using the given formatter.

impl Ord for Hierarchical

fn cmp(&self, other: &Hierarchical) -> 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 PartialEq for Hierarchical

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

fn partial_cmp(&self, other: &Hierarchical) -> 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 Eq for Hierarchical

impl StructuralPartialEq for Hierarchical