Enum ebml_iterable::specs::Master

pub enum Master<T>where
    T: Clone,{
    Start,
    End,
    Full(Vec<T, Global>),
}

An enum that defines different possible states of a TagDataType::Master tag.

A “master” tag is a type of tag that contains other tags within it. Because these tags are dynamically sized, the TagIterator emits these tags as Master::Start and Master::End variants by default so that the entire tag does not need to be buffered into memory all at once. The Master::Full variant is a complete “master” tag that includes all child tags within it.

Variants

Start

Designates the start of a tag.

End

Designates the end of a tag.

Full(Vec<T, Global>)

Designates a full tag. Vec<T> contains all child tags contained in this master tag.

Implementations

impl<T> Master<T>where
    T: Clone,

pub fn get_children(self) -> Vec<T, Global>

Convenience method to pull children from a master tag.

Panics

Panics if self is not a Full variant.

Examples

use ebml_iterable_specification::Master;

let children = vec![EmptySpec::with_data(0x1253, &[1]), EmptySpec::with_data(0x1234, &[2])];
// Clone children because creating a Master consumes it
let tag = Master::Full(children.clone());
let retrieved_children = tag.get_children();
assert_eq!(retrieved_children, children);

Trait Implementations

impl<T> Clone for Master<T>where
    T: Clone,

fn clone(&self) -> Master<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Debug for Master<T>where
    T: Debug + Clone,

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

Formats the value using the given formatter.

impl<T> Hash for Master<T>where
    T: Hash + Clone,

fn hash<__H>(&self, state: &mut __H)where
    __H: Hasher,

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<T> Ord for Master<T>where
    T: Ord + Clone,

fn cmp(&self, other: &Master<T>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl<T> PartialEq<Master<T>> for Master<T>where
    T: PartialEq<T> + Clone,

fn eq(&self, other: &Master<T>) -> bool

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T> PartialOrd<Master<T>> for Master<T>where
    T: PartialOrd<T> + Clone,

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

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

fn lt(&self, other: &Rhs) -> bool

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

fn le(&self, other: &Rhs) -> bool

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

fn gt(&self, other: &Rhs) -> bool

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

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<T> Eq for Master<T>where
    T: Eq + Clone,

impl<T> StructuralEq for Master<T>where
    T: Clone,

impl<T> StructuralPartialEq for Master<T>where
    T: Clone,