Struct kiwi_schema::Def

pub struct Def {
    pub name: String,
    pub index: i32,
    pub kind: DefKind,
    pub fields: Vec<Field>,
    pub field_value_to_index: HashMap<u32, usize>,
    pub field_name_to_index: HashMap<String, usize>,
}

Represents a single definition in a Schema. Kiwi enums, structs, and messages are all represented using this object.

Fields

name: String

The name of this field from the textual Kiwi schema.

index: i32

The index of this Def in the defs field of the parent Schema. This is used as the type identifier for any fields with this type.

kind: DefKind

Either Enum, Struct, or Message.

fields: Vec<Field>

All fields in this definition. The order matters for struct definitions.

field_value_to_index: HashMap<u32, usize>

Maps the value and name members of each Field in the fields array to its index in that array. This is helpful when decoding and encoding a field to be able to quickly get to the field metadata.

field_name_to_index: HashMap<String, usize>

Implementations

impl Def

pub fn new(name: String, kind: DefKind, fields: Vec<Field>) -> Def

pub fn field(&self, name: &str) -> Option<&Field>

Returns the Field with the provided name if one exists.

Trait Implementations

impl Debug for Def

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

Formats the value using the given formatter.

impl PartialEq<Def> for Def

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