Enum tycho::Element

pub enum Element {
    Unit,
    Value(Value),
    Option(Option<Box<Element>>),
    Variant(String, Box<Element>),
    Struct(HashMap<String, Element>),
    List(Vec<Element>),
    Array(ValueIdent, Vec<Value>),
    Map(ValueIdent, HashMap<Value, Element>),
    Compression(Box<Element>),
}

A element tag, used to build tycho data structures.

Elements represent zero, one or multiple pieces of data. They are non-primitive non-terminating and have the ability to contain typed and untyped values or elements.

Variants

Unit

Unit

A element representing no data.

Units are used when serializing from the following types:

• Unit Struct (struct Foo;)
• Unit Variant (enum Foo { Bar, Baz })
• Unit (())

Value(Value)

Value

A element representing a primitive value.

A value element contains a Value object as its payload. Data structures that only contain a value with be prefixed with the ValueIdent.

A value can represent any of the following types:

• bool
• &str,
• String
• char
• number - u8 u16 u32 u64 u128 i8 i16 i32 i64 i128 f32 f64
• bytes - Vec<u8>

Option(Option<Box<Element>>)

Option

An element representing a Some or None value.

This element maps directly to Rust Option<T> type, and can have a payload of an element when some.

Variant(String, Box<Element>)

Variant

An element representing a named variable type.

This element represents a rust enum.

Unit Variants

e.g. enum Example { Foo, Bar, Baz }

A unit variant is a enum with no data.

Within tycho, the value Example::Foo would be represented as Variant("Foo", Unit)

Value Variants

e.g. enum Example { Foo(String), Bar(bool), Baz(u8) }

A ‘new type’ enum containing a single piece of data.

Within tycho, the value Example::Bar(false) would be represented as Variant("Bar", Value(Bool(0)))

Tuple Variants

e.g. enum Example { Foo(u8, bool), Bar(u16, bool), Baz(u32, bool) }

A ‘tuple’ enum containing a multiple unnamed pieces of data.

Within tycho, the value Example::Baz(10, true) would be represented as: Variant("Baz, List([Value(Unsigned32(10)), Value(Bool(1)]))

Struct Variants

e.g. enum Example { Foo { bar: char } }

A ‘tuple’ enum containing a multiple unnamed pieces of data.

Within tycho, the value Example::Foo { bar: 'P'} would be represented as: Variant("Baz, Struct({"bar": Value(Char('P'))))

Struct(HashMap<String, Element>)

Struct

An element representing an untyped string key - element paring.

Directly maps to rusts struct object within the serialisation process.

List(Vec<Element>)

List

An element representing an untyped collection of elements.

Directly maps to any tuple or heterogeneous array.

Array(ValueIdent, Vec<Value>)

Array

An element representing a strictly typed collection of values.

Unlike lists, arrays can only store terminating values and homogeneous.

Map(ValueIdent, HashMap<Value, Element>)

Map

An element representing a strictly typed key - to untyped element pair.

They key of a map can be any terminating value, and is strictly typed. The value of a map can be any element and is homogeneous.

Compression(Box<Element>)

Compression Marker

Contains an element that will be g-zip compressed.

Trait Implementations

impl Clone for Element

fn clone(&self) -> Element

Returns a copy of the value.

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

Performs copy-assignment from source.

impl CompressElement for Element

fn compress(self) -> Self

Mark an element for compression by placing it within a compression element.

impl Debug for Element

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

Formats the value using the given formatter.

impl DecompressElement for Element

fn _impl_decompress(self) -> Result<Self, (Self, TychoError)>

fn decompress(self) -> TychoResult<Self>

Mark an element for decompression by extracting it from a compression element.

fn decompress_lossy(self) -> Self

Mark an element for decompression by extracting it from a compression element. If the function fails, the element will be returned untouched.

fn decompress_opt(self) -> Option<Self>

Mark an element for decompression by extracting it from a compression element. If the function fails, None is returned

impl Display for Element

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

Formats the value using the given formatter.

impl From<&'_ [u8]> for Element

fn from(value: &[u8]) -> Self

Performs the conversion.

impl From<&'_ str> for Element

fn from(value: &str) -> Self

Performs the conversion.

impl<T: ValueType> From<Array<T>> for Element

fn from(a: Array<T>) -> Self

Performs the conversion.

impl From<List> for Element

fn from(l: List) -> Self

Performs the conversion.

impl<K: ValueType + Hash + Eq> From<Map<K>> for Element

fn from(m: Map<K>) -> Self

Performs the conversion.

impl From<String> for Element

fn from(value: String) -> Self

Performs the conversion.

impl From<Struct> for Element

fn from(s: Struct) -> Self

Performs the conversion.

impl From<Uuid> for Element

fn from(value: Uuid) -> Self

Performs the conversion.

impl From<Value> for Element

fn from(v: Value) -> Self

Performs the conversion.

impl From<Vec<u8, Global>> for Element

fn from(value: Vec<u8>) -> Self

Performs the conversion.

impl From<bool> for Element

fn from(value: bool) -> Self

Performs the conversion.

impl From<char> for Element

fn from(value: char) -> Self

Performs the conversion.

impl From<f32> for Element

fn from(value: f32) -> Self

Performs the conversion.

impl From<f64> for Element

fn from(value: f64) -> Self

Performs the conversion.

impl From<i128> for Element

fn from(value: i128) -> Self

Performs the conversion.

impl From<i16> for Element

fn from(value: i16) -> Self

Performs the conversion.

impl From<i32> for Element

fn from(value: i32) -> Self

Performs the conversion.

impl From<i64> for Element

fn from(value: i64) -> Self

Performs the conversion.

impl From<i8> for Element

fn from(value: i8) -> Self

Performs the conversion.

impl From<u128> for Element

fn from(value: u128) -> Self

Performs the conversion.

impl From<u16> for Element

fn from(value: u16) -> Self

Performs the conversion.

impl From<u32> for Element

fn from(value: u32) -> Self

Performs the conversion.

impl From<u64> for Element

fn from(value: u64) -> Self

Performs the conversion.

impl From<u8> for Element

fn from(value: u8) -> Self

Performs the conversion.

impl Ident for Element

type IdentType = ElementIdent

Respective ident type

fn ident(&self) -> Self::IdentType

Get the respective ident for the element.

impl PartialEq<Element> for Element

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

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

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

This method tests for !=.

impl StructuralPartialEq for Element

impl TryFrom<Element> for Vec<u8>

type Error = ()

The type returned in the event of a conversion error.

fn try_from(value: Element) -> Result<Self, Self::Error>

Performs the conversion.

impl<K: ValueType + TryFrom<Value>> TryFrom<Element> for Array<K>

type Error = ()

The type returned in the event of a conversion error.

fn try_from(value: Element) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Element> for List

type Error = ()

The type returned in the event of a conversion error.

fn try_from(value: Element) -> Result<Self, Self::Error>

Performs the conversion.

impl<K: ValueType + Hash + Eq + TryFrom<Value>> TryFrom<Element> for Map<K>

type Error = ()

The type returned in the event of a conversion error.

fn try_from(value: Element) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Element> for Struct

type Error = ()

The type returned in the event of a conversion error.

fn try_from(value: Element) -> Result<Self, Self::Error>

Performs the conversion.