Struct CodecMember 

pub struct CodecMember { /* private fields */ }

One member of a declared shape: what the owner calls it, the type it is held at, how it is written, and how many of it there are.

Bounds

The spelling is one Rust identifier by construction, because the decode road binds a local under it and the encode road reads a field under it — and a spelling that is not one renders tokens the caller’s compiler reads as something else.

Implementations

impl CodecMember

pub fn declared( spelling: &str, held_as: CodecTypePath, shape: CodecMemberShape, cardinality: Cardinality, ) -> Result<Self, CodecError>

Declare one member of a shape.

Errors

Returns CodecIssue::MemberSpellingAbsent where the member states no spelling, and CodecIssue::MemberSpellingNotAnIdentifier where the spelling cannot name a rendered item — not one Rust identifier, or a keyword the language already took. The two are dependent — there is no alphabet to read until there are characters — so exactly one is ever established.

pub fn spelling(&self) -> &str

What the owner calls this member.

pub const fn held_as(&self) -> &CodecTypePath

The type ONE OCCURRENCE of this member is held at, never the collection or the option a cardinality wraps it in.

pub const fn shape(&self) -> CodecMemberShape

How this member is written.

pub const fn cardinality(&self) -> Cardinality

How many of this member there are.

Trait Implementations

impl Clone for CodecMember

fn clone(&self) -> CodecMember

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CodecMember

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

Formats the value using the given formatter.

impl Eq for CodecMember

impl Hash for CodecMember

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

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 PartialEq for CodecMember

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for CodecMember