Struct Struct

pub struct Struct {
    pub name: String,
    pub serde_name: String,
    pub description: String,
    pub parameters: Vec<TypeParameter>,
    pub fields: Fields,
    pub transparent: bool,
    pub codegen_config: LanguageSpecificTypeCodegenConfig,
}

Fields

name: String

Name of a struct, should be a valid Rust struct name identifier

serde_name: String

If a serialized name is not a valid Rust struct name identifier then this defines the name of a struct to be used in serialization

description: String

Markdown docs for the struct

parameters: Vec<TypeParameter>

Generic type parameters, if any

fields: Fields

transparent: bool

If serde transparent attribute is set on a struct

codegen_config: LanguageSpecificTypeCodegenConfig

Implementations

impl Struct

pub fn new(name: impl Into<String>) -> Self

pub fn name(&self) -> &str

Returns the name of a struct, should be a valid Rust struct name identifier

pub fn serde_name(&self) -> &str

Returns the name of a struct to be used in serialization

pub fn description(&self) -> &str

pub fn parameters(&self) -> Iter<'_, TypeParameter>

pub fn fields(&self) -> Iter<'_, Field>

pub fn transparent(&self) -> bool

pub fn is_alias(&self) -> bool

Returns true if a struct has 1 field and it is either named “0” or is transparent in the serialized form

pub fn is_unit(&self) -> bool

Returns true is a struct is a Rust unit struct. Please note, that a unit struct is also an alias

pub fn is_tuple(&self) -> bool

Returns true if a struct is a Rust tuple struct.

Trait Implementations

impl Clone for Struct

fn clone(&self) -> Struct

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Struct

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Struct

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<Struct> for Type

fn from(val: Struct) -> Self

Converts to this type from the input type.

impl Hash for Struct

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 Instantiate for Struct

fn instantiate(self, type_args: &[TypeReference]) -> Self

Return a new non-generic Struct with each type parameter substituted with a type

impl PartialEq for Struct

fn eq(&self, other: &Struct) -> 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 Serialize for Struct

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl VisitMut for Struct

fn visit_mut<V: Visitor>( &mut self, visitor: &mut V, ) -> ControlFlow<V::Output, V::Output>

impl Eq for Struct

impl StructuralPartialEq for Struct