Struct StructType 

pub struct StructType { /* private fields */ }

This represents a structured aggregate type

Implementations

impl StructType

pub fn new<I>(fields: I) -> StructType

where I: IntoIterator, <I as IntoIterator>::Item: Into<NameAndType>,

Create a new struct with default representation, i.e. a struct with representation of TypeRepr::Packed(1).

pub fn named<I>(name: Arc<str>, fields: I) -> StructType

where I: IntoIterator, <I as IntoIterator>::Item: Into<NameAndType>,

Create a new struct with default representation, i.e. a struct with representation of TypeRepr::Packed(1).

pub fn new_with_repr<I>(repr: TypeRepr, fields: I) -> StructType

where I: IntoIterator, <I as IntoIterator>::Item: Into<NameAndType>,

Create a new struct with the given representation.

This function will panic if the rules of the given representation are violated.

pub fn from_parts<I>( name: Option<Arc<str>>, repr: TypeRepr, fields: I, ) -> StructType

where I: IntoIterator, <I as IntoIterator>::Item: Into<NameAndType>,

Create a new struct from the given name, repr, and fields.

This function will panic if the rules of the given representation are violated.

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

Get the name of this struct, if provided.

pub const fn repr(&self) -> TypeRepr

Get the TypeRepr for this struct

pub fn min_alignment(&self) -> usize

Get the minimum alignment for this struct

pub fn size(&self) -> usize

Get the total size in bytes required to hold this struct, including alignment padding

pub fn get(&self, index: usize) -> &StructField

Get the struct field at index, relative to declaration order.

pub fn fields(&self) -> &[StructField]

Get the struct fields as a slice

pub fn is_empty(&self) -> bool

Returns true if this struct has no fields

pub fn len(&self) -> usize

Get the length of this struct (i.e. number of fields)

Trait Implementations

impl Clone for StructType

fn clone(&self) -> StructType

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StructType

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for StructType

fn deserialize<__D>( __deserializer: __D, ) -> Result<StructType, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for StructType

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

Formats the value using the given formatter.

impl From<StructType> for Type

fn from(ty: StructType) -> Type

Converts to this type from the input type.

impl Hash for StructType

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 StructType

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PrettyPrint for StructType

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 Serialize for StructType

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<Type> for StructType

type Error = Type

The type returned in the event of a conversion error.

fn try_from( ty: Type, ) -> Result<StructType, <StructType as TryFrom<Type>>::Error>

Performs the conversion.

impl Eq for StructType

impl StructuralPartialEq for StructType