Skip to main content

StructTypeInfo

Struct StructTypeInfo 

Source
pub struct StructTypeInfo {
    pub structure_type: StructureType,
    pub fields: Vec<ParsedStructureField>,
    pub index_by_name: HashMap<String, usize>,
    pub encoding_ids: EncodingIds,
    pub is_abstract: bool,
    pub node_id: NodeId,
    pub name: String,
}
Expand description

Parsed info about a structure type.

Fields§

§structure_type: StructureType

Structure variant. Structure, StructureWithOptionalFields, or Union.

§fields: Vec<ParsedStructureField>

List of structure fields. The order is significant.

§index_by_name: HashMap<String, usize>

Field index by name.

§encoding_ids: EncodingIds

Collection of encoding IDs.

§is_abstract: bool

Whether this type is abstract and cannot be instantiated.

§node_id: NodeId

Structure node ID.

§name: String

Structure name.

Implementations§

Source§

impl StructTypeInfo

Source

pub fn get_field(&self, idx: usize) -> Option<&ParsedStructureField>

Get a field by index.

Source

pub fn get_field_by_name(&self, idx: &str) -> Option<&ParsedStructureField>

Get a field by name.

Source

pub fn is_supported(&self) -> bool

Return whether this struct is supported by the current version of the library. Types that are not supported will panic on encoding, and be skipped when decoding.

Currently this is only structures and unions with subtyped values.

Trait Implementations§

Source§

impl Debug for StructTypeInfo

Source§

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

Formats the value using the given formatter. Read more
Source§

impl From<StructTypeInfo> for TypeInfo

Source§

fn from(value: StructTypeInfo) -> Self

Converts to this type from the input type.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more