fack-codegen 0.1.2

Standalone code generation engine for fack error handling
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84

//! The enumeration error type.

use alloc::vec::Vec;

use syn::{Generics, Ident, Type};

use super::{
    common::{FieldRef, Format, ImportRoot, InlineOptions, Transparent},
    structure::FieldList,
};

/// An enumeration that corresponds to an **error** type.
#[derive(Clone, Debug, PartialEq, Eq, Hash)]
pub struct Enumeration {
    /// The inline behavior for this enumeration.
    pub inline_opts: Option<InlineOptions>,

    /// The import root for this enumeration.
    pub root_import: Option<ImportRoot>,

    /// The identifier of this enumeration.
    pub name_ident: Ident,

    /// The generic parameters of this enumeration.
    pub generics: Generics,

    /// The variant list of this enumeration.
    pub variant_list: Vec<Variant>,
}

/// A single variant of an enumeration.
#[derive(Clone, Debug, PartialEq, Eq, Hash)]
pub enum Variant {
    /// A struct-like variant that is composed of a list of fields.
    Struct {
        /// The formatter setting for this variant.
        format: Format,

        /// The field to be used as the source of the error.
        source_field: Option<FieldRef>,

        /// The name of the current variant.
        variant_name: Ident,

        /// The field list of this struct-like variant.
        field_list: FieldList,
    },

    /// An unit variant that has no fields.
    Unit {
        /// The formatter setting for this variant.
        format: Format,

        /// The name of the current variant.
        variant_name: Ident,
    },

    /// A transparent variant that is transparent over some downstream type.s
    Transparent {
        /// The transparence setting for this variant.
        transparent: Transparent,

        /// The name of the current variant.
        variant_name: Ident,

        /// The field list of this struct-like variant.
        field_list: FieldList,
    },

    /// A forward variant that forwards to one of its fields.
    Forward {
        /// The formatter setting for this variant.
        format: Format,

        /// The name of the current variant.
        variant_name: Ident,

        /// The forwarded field.
        field_ref: FieldRef,

        /// The type of the forwarded field.
        field_type: Type,
    },
}