Struct blaze_pk::Tag

pub struct Tag(pub String, pub ValueType);

Tag for a Tdf value. This contains the String tag for naming the field and then the type of the field

Tuple Fields

0: String

1: ValueType

Implementations

impl Tag

pub fn expect<T: Codec>(reader: &mut Reader<'_>, tag: &str) -> CodecResult<T>

pub fn try_expect<T: Codec>(
    reader: &mut Reader<'_>,
    tag: &str
) -> CodecResult<Option<T>>

pub fn take_two(reader: &mut Reader<'_>) -> CodecResult<()>

Tries to take a byte from the front checking if its a two and stepping back if the value isn’t two

pub fn stringify(
    reader: &mut Reader<'_>,
    out: &mut String,
    indent: usize
) -> CodecResult<()>

pub fn create_string_tag(
    reader: &mut Reader<'_>,
    out: &mut String,
    indent: usize
) -> CodecResult<()>

pub fn create_string_type(
    reader: &mut Reader<'_>,
    out: &mut String,
    indent: usize,
    ty: &ValueType
) -> CodecResult<()>

pub fn discard_tag(reader: &mut Reader<'_>) -> CodecResult<()>

Discards the next tag and all of its contents

pub fn discard_type(ty: &ValueType, reader: &mut Reader<'_>) -> CodecResult<()>

Discards the provided type of value

pub fn discard_group(reader: &mut Reader<'_>) -> CodecResult<()>

Discards any remaining tags in the group to exhaust the remaining bytes until the group ending byte

pub fn encode_from(tag: &str, value_type: &ValueType, output: &mut Vec<u8>)

Encodes a tag directly using the provided values

pub fn encode_tag(tag: &str, output: &mut Vec<u8>)

Encodes the provided tag into its byte form and appends it to the provided output vec

Trait Implementations

impl Codec for Tag

fn encode(&self, output: &mut Vec<u8>)

Function for implementing encoding of Self to the provided vec of bytes

fn decode(reader: &mut Reader<'_>) -> CodecResult<Self>

Function for implementing decoding of Self from the provided Reader. Will return None if self cannot be decoded

fn skip(reader: &mut Reader<'_>) -> CodecResult<()>

Function to provide functionality for skipping this data type (e.g. read the bytes without using them)

fn value_type() -> ValueType

Optional additional specifier for Tdf types that tells which type this is

fn encode_bytes(&self) -> Vec<u8>

Shortcut function for encoding self directly to a Vec of bytes

impl Debug for Tag

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

Formats the value using the given formatter.

impl PartialEq<Tag> for Tag

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

impl StructuralEq for Tag

impl StructuralPartialEq for Tag