doku 0.21.1

A framework for documenting Rust data structures
Documentation
use crate::*;

#[derive(Clone, Debug)]
pub enum TypeKind {
    /// A homogeneous array of a possibly known size
    Array {
        /// Type of items this array accepts
        ty: Box<Type>,

        /// An optional hint about the array's expected size
        size: Option<usize>,
    },

    /// `true` / `false`
    Bool,

    /// An algebraic data type
    Enum {
        /// The way enum should be serialized
        tag: Tag,

        /// All enum's variants
        variants: Vec<Variant>,
    },

    /// A floating-point number
    Float,

    /// An integer number
    Integer,

    /// A homogeneous map
    Map { key: Box<Type>, value: Box<Type> },

    /// `Option<Ty>`
    Optional { ty: Box<Type> },

    /// A UTF-8 string
    String,

    /// A structure
    Struct {
        fields: Fields,

        /// Whether this type should behave as a passthrough-wrapper.
        /// Corresponds to `#[serde(transparent)]`.
        transparent: bool,
    },

    /// A heterogeneous list of an up-front known size
    Tuple { fields: Vec<Type> },
}

impl From<Fields> for TypeKind {
    fn from(fields: Fields) -> Self {
        TypeKind::Struct {
            fields,
            transparent: false,
        }
    }
}