Enum StructRef 

pub enum StructRef {
    Plain(Arc<StructType>),
    Rec(RecTypeRef),
}

A struct type, which may be ordinary or recursive.

Recursive structs are kept inside Type::Struct rather than given their own Type variant so that shape tests such as Type::is_struct, and any match arm selecting a struct, keep working unchanged and correctly include recursive types. Reading a struct’s contents goes through StructRef::get, which is where the recursive case has to be considered.

Variants

Plain(Arc<StructType>)

An ordinary struct.

Rec(RecTypeRef)

A recursive struct: one definition of a recursive group.

Implementations

impl StructRef

pub fn get(&self) -> Cow<'_, StructType>

Read this struct’s definition.

This is borrowed for an ordinary struct, and owned for a recursive one, where it is the one-level unfolding of the definition. Every field type of the result is an ordinary, closed Type.

NOTE: The unfolded form of a recursive struct is a transient view, not a canonical value: it does not compare equal to the recursive type it came from. Do not store it as the representation of a type.

pub fn name(&self) -> Option<Arc<str>>

The name of this struct, if it has one. Never unfolds.

pub fn repr(&self) -> TypeRepr

The representation of this struct. Never unfolds.

pub fn size(&self) -> usize

The size in bytes of this struct, including alignment padding. Never unfolds.

pub fn min_alignment(&self) -> usize

The minimum alignment of this struct. Never unfolds.

pub fn is_zst(&self) -> bool

Whether this struct is zero-sized. Never unfolds.

pub fn is_recursive(&self) -> bool

Whether this struct is recursive.

pub fn as_recursive(&self) -> Option<&RecTypeRef>

The recursive definition this struct refers to, if it is recursive.

Trait Implementations

impl Clone for StructRef

fn clone(&self) -> StructRef

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StructRef

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

Formats the value using the given formatter.

impl Eq for StructRef

impl Hash for StructRef

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

where __H: Hasher,

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 StructRef

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

Equality operator ==.

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

Inequality operator !=.

impl PrettyPrint for StructRef

fn render(&self) -> Document

The core of the PrettyPrint functionality.

fn to_pretty_string(&self) -> String

Produce a String containing the results of pretty-printing this object.

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

Pretty-print this object to the given core::fmt::Formatter.

impl StructuralPartialEq for StructRef