Struct CodecShape 

pub struct CodecShape { /* private fields */ }

The complete declared shape one codec is rendered for.

Bounds

The member set is structurally non-empty: a codec over no member writes no byte and reads none, so it could refuse for one reason and would admit every other input — and a codec that cannot refuse is not the validator this home says a codec is.

The rendered refusal’s spelling is carried rather than derived, because it is a type declared in the caller’s own scope and this home may not choose a name there.

Implementations

impl CodecShape

pub fn declared( owner: CodecTypePath, refusal: &str, assembly: CodecAssembly, members: Vec<CodecMember>, ) -> Result<Self, CodecError>

Declare one complete shape.

Errors

Returns CodecIssue::RefusalSpellingNotAnIdentifier where the rendered refusal’s spelling cannot name a rendered item — not one Rust identifier, or a keyword the language already took — then whatever the pass over the offered members established — CodecIssue::MemberSpellingDoubled and CodecIssue::MemberShadowsBinding, which co-establish — then CodecIssue::MembersAbsent where no member was supplied and CodecIssue::MembersUnbounded where the members outgrow the declared magnitude.

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

The type the codec is written for.

pub fn refusal(&self) -> &str

The spelling the rendered decode refusal is declared under.

pub const fn assembly(&self) -> &CodecAssembly

The road the decoded members are assembled by.

pub fn members(&self) -> impl Iterator<Item = &CodecMember>

The members, in the order the shape declares them.

Ordering

This order IS meaning: it is the order the encode road writes and the decode road reads, so the same members supplied in another order are a different byte string for the same value — which is exactly what a canonical encoding may not have two of.

pub fn count(&self) -> usize

How many members the shape declares; structurally at least one.

Trait Implementations

impl Clone for CodecShape

fn clone(&self) -> CodecShape

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CodecShape

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

Formats the value using the given formatter.

impl Eq for CodecShape

impl Hash for CodecShape

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 CodecShape

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for CodecShape