[go: up one dir, main page]

bon 3.0.1

Next-gen compile-time-checked builder generator, named function's arguments, and more!
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
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134

#![allow(
    non_upper_case_globals,
    missing_debug_implementations,
    clippy::wildcard_imports
)]

/// Completions for the top-level `builder` attribute.
pub mod builder_top_level {
    use super::*;

    /// See the docs at <https://bon-rs.com/reference/builder/top-level/builder_type>
    pub const builder_type: Option<Identifier> = None;

    pub mod builder_type {
        use super::*;

        /// See the docs at <https://bon-rs.com/reference/builder/top-level/builder_type#name>
        pub const name: Identifier = Identifier;

        /// See the docs at <https://bon-rs.com/reference/builder/top-level/builder_type#vis>
        pub const vis: VisibilityString = VisibilityString;

        /// See the docs at <https://bon-rs.com/reference/builder/top-level/builder_type#doc>
        pub const doc: DocComments = DocComments;
    }

    /// See the docs at <https://bon-rs.com/reference/builder/top-level/finish_fn>
    pub const finish_fn: Option<Identifier> = None;

    /// See the docs at <https://bon-rs.com/reference/builder/top-level/finish_fn>
    pub mod finish_fn {
        use super::*;

        /// See the docs at <https://bon-rs.com/reference/builder/top-level/finish_fn#name>
        pub const name: Identifier = Identifier;

        /// See the docs at <https://bon-rs.com/reference/builder/top-level/finish_fn#vis>
        pub const vis: VisibilityString = VisibilityString;

        /// See the docs at <https://bon-rs.com/reference/builder/top-level/finish_fn#doc>
        pub const doc: DocComments = DocComments;
    }

    /// See the docs at <https://bon-rs.com/reference/builder/top-level/start_fn>
    pub const start_fn: Option<Identifier> = None;

    /// See the docs at <https://bon-rs.com/reference/builder/top-level/start_fn>
    pub mod start_fn {
        use super::*;

        /// See the docs at <https://bon-rs.com/reference/builder/top-level/start_fn#name>
        pub const name: Identifier = Identifier;

        /// See the docs at <https://bon-rs.com/reference/builder/top-level/start_fn#vis>
        pub const vis: VisibilityString = VisibilityString;

        /// See the docs at <https://bon-rs.com/reference/builder/top-level/start_fn#doc>
        pub const doc: DocComments = DocComments;
    }

    /// See the docs at <https://bon-rs.com/reference/builder/top-level/state_mod>
    pub const state_mod: Option<Identifier> = None;

    /// See the docs at <https://bon-rs.com/reference/builder/top-level/state_mod>
    pub mod state_mod {
        use super::*;

        /// See the docs at <https://bon-rs.com/reference/builder/top-level/state_mod#name>
        pub const name: Identifier = Identifier;

        /// See the docs at <https://bon-rs.com/reference/builder/top-level/state_mod#vis>
        pub const vis: VisibilityString = VisibilityString;

        /// See the docs at <https://bon-rs.com/reference/builder/top-level/state_mod#doc>
        pub const doc: DocComments = DocComments;
    }

    /// See the docs at <https://bon-rs.com/reference/builder/top-level/on>
    pub mod on {
        use super::*;

        /// See the docs at <https://bon-rs.com/reference/builder/top-level/on>
        pub const into: Flag = Flag;

        /// See the docs at <https://bon-rs.com/reference/builder/top-level/on>
        pub const required: Flag = Flag;

        /// See the docs at <https://bon-rs.com/reference/builder/top-level/on>
        pub const overwritable: Flag = Flag;
    }

    /// See the docs at <https://bon-rs.com/reference/builder/top-level/derive>
    pub mod derive {
        /// See the docs at <https://bon-rs.com/reference/builder/top-level/derive>
        pub use core::fmt::Debug;

        /// See the docs at <https://bon-rs.com/reference/builder/top-level/derive>
        pub use core::clone::Clone;
    }

    /// The real name of this parameter is `crate` (without the underscore).
    /// It's hinted with an underscore due to the limitations of the current
    /// completions limitation. This will be fixed in the future.
    ///
    /// See the docs at <https://bon-rs.com/reference/builder/top-level/crate>
    pub const crate_: Option<Path> = None;
}

/// Visibility inside of a string literal. Empty string means private visibility.
///
/// Examples:
///
/// - `""` - the symbol is private (accessible only within the same module)
/// - `"pub"` - the symbol is accessible outside of the crate
/// - `"pub(crate)"` - the symbol is accessible anywhere inside of the crate, but not outside of it
///
/// [Rust reference](https://doc.rust-lang.org/reference/visibility-and-privacy.html)
pub struct VisibilityString;

/// [Rust reference](https://doc.rust-lang.org/reference/identifiers.html)
pub struct Identifier;

/// The presence of this attribute enables the behavior. The attribute has no value.
pub struct Flag;

/// Documentation comments using the syntax `/// doc comment here`.
///
/// [Rust reference](https://doc.rust-lang.org/reference/comments.html#doc-comments)
pub struct DocComments;

/// Simple path that is valid in a `use` statement. Example: `foo::bar::baz`.
///
/// [Rust reference](https://doc.rust-lang.org/reference/paths.html?highlight=path#simple-paths)
pub struct Path;