···

       
227
       
 
       
    };

     

       
228
       
 
       


     

       
229
       
 
       
    int = mkOptionType {

     

       
230
       
-
       
        name = "int";

     

       
231
       
-
       
        description = "signed integer";

     

       
232
       
-
       
        check = isInt;

     

       
233
       
-
       
        merge = mergeEqualOption;

     

       
234
       
-
       
      };

     

       
235
       
 
       


     

       
236
       
 
       
    # Specialized subdomains of int

     

       
237
       
 
       
    ints =

     
···

       
292
       
 
       
    port = ints.u16;

     

       
293
       
 
       


     

       
294
       
 
       
    float = mkOptionType {

     

       
295
       
-
       
        name = "float";

     

       
296
       
-
       
        description = "floating point number";

     

       
297
       
-
       
        check = isFloat;

     

       
298
       
-
       
        merge = mergeEqualOption;

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
299
       
 
       
    };

     

       
300
       
 
       


     

       
301
       
 
       
    str = mkOptionType {

     

···

       
227
       
 
       
    };

     

       
228
       
 
       


     

       
229
       
 
       
    int = mkOptionType {

     

       
230
       
+
       
      name = "int";

     

       
231
       
+
       
      description = "signed integer";

     

       
232
       
+
       
      check = isInt;

     

       
233
       
+
       
      merge = mergeEqualOption;

     

       
234
       
+
       
    };

     

       
235
       
 
       


     

       
236
       
 
       
    # Specialized subdomains of int

     

       
237
       
 
       
    ints =

     
···

       
292
       
 
       
    port = ints.u16;

     

       
293
       
 
       


     

       
294
       
 
       
    float = mkOptionType {

     

       
295
       
+
       
      name = "float";

     

       
296
       
+
       
      description = "floating point number";

     

       
297
       
+
       
      check = isFloat;

     

       
298
       
+
       
      merge = mergeEqualOption;

     

       
299
       
+
       
    };

     

       
300
       
+
       


     

       
301
       
+
       
    number = either int float;

     

       
302
       
+
       


     

       
303
       
+
       
    numbers = let

     

       
304
       
+
       
      betweenDesc = lowest: highest:

     

       
305
       
+
       
        "${builtins.toJSON lowest} and ${builtins.toJSON highest} (both inclusive)";

     

       
306
       
+
       
    in {

     

       
307
       
+
       
      between = lowest: highest:

     

       
308
       
+
       
        assert lib.assertMsg (lowest <= highest)

     

       
309
       
+
       
          "numbers.between: lowest must be smaller than highest";

     

       
310
       
+
       
        addCheck number (x: x >= lowest && x <= highest) // {

     

       
311
       
+
       
          name = "numberBetween";

     

       
312
       
+
       
          description = "integer or floating point number between ${betweenDesc lowest highest}";

     

       
313
       
+
       
        };

     

       
314
       
+
       


     

       
315
       
+
       
      nonnegative = addCheck number (x: x >= 0) // {

     

       
316
       
+
       
        name = "numberNonnegative";

     

       
317
       
+
       
        description = "nonnegative integer or floating point number, meaning >=0";

     

       
318
       
+
       
      };

     

       
319
       
+
       
      positive = addCheck number (x: x > 0) // {

     

       
320
       
+
       
        name = "numberPositive";

     

       
321
       
+
       
        description = "positive integer or floating point number, meaning >0";

     

       
322
       
+
       
      };

     

       
323
       
 
       
    };

     

       
324
       
 
       


     

       
325
       
 
       
    str = mkOptionType {

     

···

       
4
       
 
       
can take. Types are also responsible of how values are merged in case of

     

       
5
       
 
       
multiple value definitions.

     

       
6
       
 
       


     

       
7
       
-
       
## Basic Types {#sec-option-types-basic}

     

       
8
       
 
       


     

       
9
       
 
       
Basic types are the simplest available types in the module system. Basic

     

       
10
       
 
       
types include multiple string types that mainly differ in how definition

     
···

       
24
       
 
       


     

       
25
       
 
       
:   A top-level store path. This can be an attribute set pointing

     

       
26
       
 
       
    to a store path, like a derivation or a flake input.

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
27
       
 
       


     

       
28
       
 
       
`types.anything`

     

       
29
       
 
       


     
···

       
95
       
 
       
    problems.

     

       
96
       
 
       
    :::

     

       
97
       
 
       


     

       
98
       
-
       
Integer-related types:

     

       
99
       
 
       


     

       
100
       
 
       
`types.int`

     

       
101
       
 
       


     
···

       
118
       
 
       
    from 0 to 2^n−1 respectively (e.g. `0`

     

       
119
       
 
       
    to `255` for 8 bits).

     

       
120
       
 
       


     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
121
       
 
       
`types.ints.positive`

     

       
122
       
 
       


     

       
123
       
 
       
:   A positive integer (that is > 0).

     
···

       
127
       
 
       
:   A port number. This type is an alias to

     

       
128
       
 
       
    `types.ints.u16`.

     

       
129
       
 
       


     

       
130
       
-
       
String-related types:

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
131
       
 
       


     

       
132
       
 
       
`types.str`

     

       
133
       
 
       


     

       
134
       
 
       
:   A string. Multiple definitions cannot be merged.

     

       
135
       
 
       


     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
136
       
 
       
`types.lines`

     

       
137
       
 
       


     

       
138
       
 
       
:   A string. Multiple definitions are concatenated with a new line

     
···

       
144
       
 
       


     

       
145
       
 
       
`types.envVar`

     

       
146
       
 
       


     

       
147
       
-
       
:   A string. Multiple definitions are concatenated with a collon `":"`.

     

       
148
       
 
       


     

       
149
       
 
       
`types.strMatching`

     

       
150
       
 
       


     
···

       
152
       
 
       
    definitions cannot be merged. The regular expression is processed

     

       
153
       
 
       
    using `builtins.match`.

     

       
154
       
 
       


     

       
155
       
-
       
## Value Types {#sec-option-types-value}

     

       
156
       
-
       


     

       
157
       
-
       
Value types are types that take a value parameter.

     

       
158
       
-
       


     

       
159
       
-
       
`types.enum` *`l`*

     

       
160
       
-
       


     

       
161
       
-
       
:   One element of the list *`l`*, e.g. `types.enum [ "left" "right" ]`.

     

       
162
       
-
       
    Multiple definitions cannot be merged.

     

       
163
       
-
       


     

       
164
       
-
       
`types.separatedString` *`sep`*

     

       
165
       
-
       


     

       
166
       
-
       
:   A string with a custom separator *`sep`*, e.g.

     

       
167
       
-
       
    `types.separatedString "|"`.

     

       
168
       
 
       


     

       
169
       
-
       
`types.ints.between` *`lowest highest`*

     

       
170
       
-
       


     

       
171
       
-
       
:   An integer between *`lowest`* and *`highest`* (both inclusive). Useful

     

       
172
       
-
       
    for creating types like `types.port`.

     

       
173
       
 
       


     

       
174
       
 
       
`types.submodule` *`o`*

     

       
175
       
 
       


     
···

       
178
       
 
       
    value. Submodules are used in composed types to create modular

     

       
179
       
 
       
    options. This is equivalent to

     

       
180
       
 
       
    `types.submoduleWith { modules = toList o; shorthandOnlyDefinesConfig = true; }`.

     

       
181
       
-
       
    Submodules are detailed in [Submodule](#section-option-types-submodule).

     

       
182
       
 
       


     

       
183
       
 
       
`types.submoduleWith` { *`modules`*, *`specialArgs`* ? {}, *`shorthandOnlyDefinesConfig`* ? false }

     

       
184
       
 
       


     
···

       
239
       
 
       
    more convenient and discoverable than expecting the module user to

     

       
240
       
 
       
    type-merge with the `attrsOf submodule` option.

     

       
241
       
 
       


     

       
242
       
-
       
## Composed Types {#sec-option-types-composed}

     

       
243
       
 
       


     

       
244
       
 
       
Composed types are types that take a type as parameter. `listOf

     

       
245
       
 
       
   int` and `either int str` are examples of composed types.

     
···

       
496
       
 
       
    of strings, and `defs` the list of defined values as a list. It is

     

       
497
       
 
       
    possible to override a type merge function for custom needs.

     

       
498
       
 
       


     

       
499
       
-
       
## Custom Types {#sec-option-types-custom}

     

       
500
       
 
       


     

       
501
       
 
       
Custom types can be created with the `mkOptionType` function. As type

     

       
502
       
 
       
creation includes some more complex topics such as submodule handling,

     

···

       
4
       
 
       
can take. Types are also responsible of how values are merged in case of

     

       
5
       
 
       
multiple value definitions.

     

       
6
       
 
       


     

       
7
       
+
       
## Basic types {#sec-option-types-basic}

     

       
8
       
 
       


     

       
9
       
 
       
Basic types are the simplest available types in the module system. Basic

     

       
10
       
 
       
types include multiple string types that mainly differ in how definition

     
···

       
24
       
 
       


     

       
25
       
 
       
:   A top-level store path. This can be an attribute set pointing

     

       
26
       
 
       
    to a store path, like a derivation or a flake input.

     

       
27
       
+
       


     

       
28
       
+
       
`types.enum` *`l`*

     

       
29
       
+
       


     

       
30
       
+
       
:   One element of the list *`l`*, e.g. `types.enum [ "left" "right" ]`.

     

       
31
       
+
       
    Multiple definitions cannot be merged.

     

       
32
       
 
       


     

       
33
       
 
       
`types.anything`

     

       
34
       
 
       


     
···

       
100
       
 
       
    problems.

     

       
101
       
 
       
    :::

     

       
102
       
 
       


     

       
103
       
+
       
### Numeric types {#sec-option-types-numeric}

     

       
104
       
 
       


     

       
105
       
 
       
`types.int`

     

       
106
       
 
       


     
···

       
123
       
 
       
    from 0 to 2^n−1 respectively (e.g. `0`

     

       
124
       
 
       
    to `255` for 8 bits).

     

       
125
       
 
       


     

       
126
       
+
       
`types.ints.between` *`lowest highest`*

     

       
127
       
+
       


     

       
128
       
+
       
:   An integer between *`lowest`* and *`highest`* (both inclusive).

     

       
129
       
+
       


     

       
130
       
 
       
`types.ints.positive`

     

       
131
       
 
       


     

       
132
       
 
       
:   A positive integer (that is > 0).

     
···

       
136
       
 
       
:   A port number. This type is an alias to

     

       
137
       
 
       
    `types.ints.u16`.

     

       
138
       
 
       


     

       
139
       
+
       
`types.float`

     

       
140
       
+
       


     

       
141
       
+
       
:   A floating point number.

     

       
142
       
+
       


     

       
143
       
+
       
    ::: {.warning}

     

       
144
       
+
       
    Converting a floating point number to a string with `toString` or `toJSON`

     

       
145
       
+
       
    may result in [precision loss](https://github.com/NixOS/nix/issues/5733).

     

       
146
       
+
       
    :::

     

       
147
       
+
       


     

       
148
       
+
       
`types.number`

     

       
149
       
+
       


     

       
150
       
+
       
:   Either a signed integer or a floating point number. No implicit conversion

     

       
151
       
+
       
    is done between the two types, and multiple equal definitions will only be

     

       
152
       
+
       
    merged if they have the same type.

     

       
153
       
+
       


     

       
154
       
+
       
`types.numbers.between` *`lowest highest`*

     

       
155
       
+
       


     

       
156
       
+
       
:   An integer or floating point number between *`lowest`* and *`highest`* (both inclusive).

     

       
157
       
+
       


     

       
158
       
+
       
`types.numbers.nonnegative`

     

       
159
       
+
       


     

       
160
       
+
       
:   A nonnegative integer or floating point number (that is >= 0).

     

       
161
       
+
       


     

       
162
       
+
       
`types.numbers.positive`

     

       
163
       
+
       


     

       
164
       
+
       
:   A positive integer or floating point number (that is > 0).

     

       
165
       
+
       


     

       
166
       
+
       
### String types {#sec-option-types-string}

     

       
167
       
 
       


     

       
168
       
 
       
`types.str`

     

       
169
       
 
       


     

       
170
       
 
       
:   A string. Multiple definitions cannot be merged.

     

       
171
       
 
       


     

       
172
       
+
       
`types.separatedString` *`sep`*

     

       
173
       
+
       


     

       
174
       
+
       
:   A string. Multiple definitions are concatenated with *`sep`*, e.g.

     

       
175
       
+
       
    `types.separatedString "|"`.

     

       
176
       
+
       


     

       
177
       
 
       
`types.lines`

     

       
178
       
 
       


     

       
179
       
 
       
:   A string. Multiple definitions are concatenated with a new line

     
···

       
185
       
 
       


     

       
186
       
 
       
`types.envVar`

     

       
187
       
 
       


     

       
188
       
+
       
:   A string. Multiple definitions are concatenated with a colon `":"`.

     

       
189
       
 
       


     

       
190
       
 
       
`types.strMatching`

     

       
191
       
 
       


     
···

       
193
       
 
       
    definitions cannot be merged. The regular expression is processed

     

       
194
       
 
       
    using `builtins.match`.

     

       
195
       
 
       


     

       
196
       
+
       
## Submodule types {#sec-option-types-submodule}

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
197
       
 
       


     

       
198
       
+
       
Submodules are detailed in [Submodule](#section-option-types-submodule).

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
199
       
 
       


     

       
200
       
 
       
`types.submodule` *`o`*

     

       
201
       
 
       


     
···

       
204
       
 
       
    value. Submodules are used in composed types to create modular

     

       
205
       
 
       
    options. This is equivalent to

     

       
206
       
 
       
    `types.submoduleWith { modules = toList o; shorthandOnlyDefinesConfig = true; }`.

     

       
0
       
 
       

     

       
207
       
 
       


     

       
208
       
 
       
`types.submoduleWith` { *`modules`*, *`specialArgs`* ? {}, *`shorthandOnlyDefinesConfig`* ? false }

     

       
209
       
 
       


     
···

       
264
       
 
       
    more convenient and discoverable than expecting the module user to

     

       
265
       
 
       
    type-merge with the `attrsOf submodule` option.

     

       
266
       
 
       


     

       
267
       
+
       
## Composed types {#sec-option-types-composed}

     

       
268
       
 
       


     

       
269
       
 
       
Composed types are types that take a type as parameter. `listOf

     

       
270
       
 
       
   int` and `either int str` are examples of composed types.

     
···

       
521
       
 
       
    of strings, and `defs` the list of defined values as a list. It is

     

       
522
       
 
       
    possible to override a type merge function for custom needs.

     

       
523
       
 
       


     

       
524
       
+
       
## Custom types {#sec-option-types-custom}

     

       
525
       
 
       


     

       
526
       
 
       
Custom types can be created with the `mkOptionType` function. As type

     

       
527
       
 
       
creation includes some more complex topics such as submodule handling,

     

···

       
6
       
 
       
    in case of multiple value definitions.

     

       
7
       
 
       
  </para>

     

       
8
       
 
       
  <section xml:id="sec-option-types-basic">

     

       
9
       
-
       
    <title>Basic Types</title>

     

       
10
       
 
       
    <para>

     

       
11
       
 
       
      Basic types are the simplest available types in the module system.

     

       
12
       
 
       
      Basic types include multiple string types that mainly differ in

     
···

       
46
       
 
       
            A top-level store path. This can be an attribute set

     

       
47
       
 
       
            pointing to a store path, like a derivation or a flake

     

       
48
       
 
       
            input.

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
49
       
 
       
          </para>

     

       
50
       
 
       
        </listitem>

     

       
51
       
 
       
      </varlistentry>

     
···

       
150
       
 
       
        </listitem>

     

       
151
       
 
       
      </varlistentry>

     

       
152
       
 
       
    </variablelist>

     

       
153
       
-
       
    <para>

     

       
154
       
-
       
      Integer-related types:

     

       
155
       
-
       
    </para>

     

       
156
       
-
       
    <variablelist>

     

       
157
       
-
       
      <varlistentry>

     

       
158
       
-
       
        <term>

     

       
159
       
-
       
          <literal>types.int</literal>

     

       
160
       
-
       
        </term>

     

       
161
       
-
       
        <listitem>

     

       
162
       
-
       
          <para>

     

       
163
       
-
       
            A signed integer.

     

       
164
       
-
       
          </para>

     

       
165
       
-
       
        </listitem>

     

       
166
       
-
       
      </varlistentry>

     

       
167
       
-
       
      <varlistentry>

     

       
168
       
-
       
        <term>

     

       
169
       
-
       
          <literal>types.ints.{s8, s16, s32}</literal>

     

       
170
       
-
       
        </term>

     

       
171
       
-
       
        <listitem>

     

       
172
       
-
       
          <para>

     

       
173
       
-
       
            Signed integers with a fixed length (8, 16 or 32 bits). They

     

       
174
       
-
       
            go from −2^n/2 to 2^n/2−1 respectively (e.g.

     

       
175
       
-
       
            <literal>−128</literal> to <literal>127</literal> for 8

     

       
176
       
-
       
            bits).

     

       
177
       
-
       
          </para>

     

       
178
       
-
       
        </listitem>

     

       
179
       
-
       
      </varlistentry>

     

       
180
       
-
       
      <varlistentry>

     

       
181
       
-
       
        <term>

     

       
182
       
-
       
          <literal>types.ints.unsigned</literal>

     

       
183
       
-
       
        </term>

     

       
184
       
-
       
        <listitem>

     

       
185
       
-
       
          <para>

     

       
186
       
-
       
            An unsigned integer (that is &gt;= 0).

     

       
187
       
-
       
          </para>

     

       
188
       
-
       
        </listitem>

     

       
189
       
-
       
      </varlistentry>

     

       
190
       
-
       
      <varlistentry>

     

       
191
       
-
       
        <term>

     

       
192
       
-
       
          <literal>types.ints.{u8, u16, u32}</literal>

     

       
193
       
-
       
        </term>

     

       
194
       
-
       
        <listitem>

     

       
195
       
-
       
          <para>

     

       
196
       
-
       
            Unsigned integers with a fixed length (8, 16 or 32 bits).

     

       
197
       
-
       
            They go from 0 to 2^n−1 respectively (e.g.

     

       
198
       
-
       
            <literal>0</literal> to <literal>255</literal> for 8 bits).

     

       
199
       
-
       
          </para>

     

       
200
       
-
       
        </listitem>

     

       
201
       
-
       
      </varlistentry>

     

       
202
       
-
       
      <varlistentry>

     

       
203
       
-
       
        <term>

     

       
204
       
-
       
          <literal>types.ints.positive</literal>

     

       
205
       
-
       
        </term>

     

       
206
       
-
       
        <listitem>

     

       
207
       
-
       
          <para>

     

       
208
       
-
       
            A positive integer (that is &gt; 0).

     

       
209
       
-
       
          </para>

     

       
210
       
-
       
        </listitem>

     

       
211
       
-
       
      </varlistentry>

     

       
212
       
-
       
      <varlistentry>

     

       
213
       
-
       
        <term>

     

       
214
       
-
       
          <literal>types.port</literal>

     

       
215
       
-
       
        </term>

     

       
216
       
-
       
        <listitem>

     

       
217
       
-
       
          <para>

     

       
218
       
-
       
            A port number. This type is an alias to

     

       
219
       
-
       
            <literal>types.ints.u16</literal>.

     

       
220
       
-
       
          </para>

     

       
221
       
-
       
        </listitem>

     

       
222
       
-
       
      </varlistentry>

     

       
223
       
-
       
    </variablelist>

     

       
224
       
-
       
    <para>

     

       
225
       
-
       
      String-related types:

     

       
226
       
-
       
    </para>

     

       
227
       
-
       
    <variablelist>

     

       
228
       
-
       
      <varlistentry>

     

       
229
       
-
       
        <term>

     

       
230
       
-
       
          <literal>types.str</literal>

     

       
231
       
-
       
        </term>

     

       
232
       
-
       
        <listitem>

     

       
233
       
-
       
          <para>

     

       
234
       
-
       
            A string. Multiple definitions cannot be merged.

     

       
235
       
-
       
          </para>

     

       
236
       
-
       
        </listitem>

     

       
237
       
-
       
      </varlistentry>

     

       
238
       
-
       
      <varlistentry>

     

       
239
       
-
       
        <term>

     

       
240
       
-
       
          <literal>types.lines</literal>

     

       
241
       
-
       
        </term>

     

       
242
       
-
       
        <listitem>

     

       
243
       
-
       
          <para>

     

       
244
       
-
       
            A string. Multiple definitions are concatenated with a new

     

       
245
       
-
       
            line <literal>&quot;\n&quot;</literal>.

     

       
246
       
-
       
          </para>

     

       
247
       
-
       
        </listitem>

     

       
248
       
-
       
      </varlistentry>

     

       
249
       
-
       
      <varlistentry>

     

       
250
       
-
       
        <term>

     

       
251
       
-
       
          <literal>types.commas</literal>

     

       
252
       
-
       
        </term>

     

       
253
       
-
       
        <listitem>

     

       
254
       
-
       
          <para>

     

       
255
       
-
       
            A string. Multiple definitions are concatenated with a comma

     

       
256
       
-
       
            <literal>&quot;,&quot;</literal>.

     

       
257
       
-
       
          </para>

     

       
258
       
-
       
        </listitem>

     

       
259
       
-
       
      </varlistentry>

     

       
260
       
-
       
      <varlistentry>

     

       
261
       
-
       
        <term>

     

       
262
       
-
       
          <literal>types.envVar</literal>

     

       
263
       
-
       
        </term>

     

       
264
       
-
       
        <listitem>

     

       
265
       
-
       
          <para>

     

       
266
       
-
       
            A string. Multiple definitions are concatenated with a

     

       
267
       
-
       
            collon <literal>&quot;:&quot;</literal>.

     

       
268
       
-
       
          </para>

     

       
269
       
-
       
        </listitem>

     

       
270
       
-
       
      </varlistentry>

     

       
271
       
-
       
      <varlistentry>

     

       
272
       
-
       
        <term>

     

       
273
       
-
       
          <literal>types.strMatching</literal>

     

       
274
       
-
       
        </term>

     

       
275
       
-
       
        <listitem>

     

       
276
       
-
       
          <para>

     

       
277
       
-
       
            A string matching a specific regular expression. Multiple

     

       
278
       
-
       
            definitions cannot be merged. The regular expression is

     

       
279
       
-
       
            processed using <literal>builtins.match</literal>.

     

       
280
       
-
       
          </para>

     

       
281
       
-
       
        </listitem>

     

       
282
       
-
       
      </varlistentry>

     

       
283
       
-
       
    </variablelist>

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
284
       
 
       
  </section>

     

       
285
       
-
       
  <section xml:id="sec-option-types-value">

     

       
286
       
-
       
    <title>Value Types</title>

     

       
287
       
 
       
    <para>

     

       
288
       
-
       
      Value types are types that take a value parameter.

     

       
0
       
 
       

     

       
289
       
 
       
    </para>

     

       
290
       
 
       
    <variablelist>

     

       
291
       
 
       
      <varlistentry>

     

       
292
       
 
       
        <term>

     

       
293
       
-
       
          <literal>types.enum</literal>

     

       
294
       
-
       
          <emphasis><literal>l</literal></emphasis>

     

       
295
       
-
       
        </term>

     

       
296
       
-
       
        <listitem>

     

       
297
       
-
       
          <para>

     

       
298
       
-
       
            One element of the list

     

       
299
       
-
       
            <emphasis><literal>l</literal></emphasis>, e.g.

     

       
300
       
-
       
            <literal>types.enum [ &quot;left&quot; &quot;right&quot; ]</literal>.

     

       
301
       
-
       
            Multiple definitions cannot be merged.

     

       
302
       
-
       
          </para>

     

       
303
       
-
       
        </listitem>

     

       
304
       
-
       
      </varlistentry>

     

       
305
       
-
       
      <varlistentry>

     

       
306
       
-
       
        <term>

     

       
307
       
-
       
          <literal>types.separatedString</literal>

     

       
308
       
-
       
          <emphasis><literal>sep</literal></emphasis>

     

       
309
       
-
       
        </term>

     

       
310
       
-
       
        <listitem>

     

       
311
       
-
       
          <para>

     

       
312
       
-
       
            A string with a custom separator

     

       
313
       
-
       
            <emphasis><literal>sep</literal></emphasis>, e.g.

     

       
314
       
-
       
            <literal>types.separatedString &quot;|&quot;</literal>.

     

       
315
       
-
       
          </para>

     

       
316
       
-
       
        </listitem>

     

       
317
       
-
       
      </varlistentry>

     

       
318
       
-
       
      <varlistentry>

     

       
319
       
-
       
        <term>

     

       
320
       
-
       
          <literal>types.ints.between</literal>

     

       
321
       
-
       
          <emphasis><literal>lowest highest</literal></emphasis>

     

       
322
       
-
       
        </term>

     

       
323
       
-
       
        <listitem>

     

       
324
       
-
       
          <para>

     

       
325
       
-
       
            An integer between

     

       
326
       
-
       
            <emphasis><literal>lowest</literal></emphasis> and

     

       
327
       
-
       
            <emphasis><literal>highest</literal></emphasis> (both

     

       
328
       
-
       
            inclusive). Useful for creating types like

     

       
329
       
-
       
            <literal>types.port</literal>.

     

       
330
       
-
       
          </para>

     

       
331
       
-
       
        </listitem>

     

       
332
       
-
       
      </varlistentry>

     

       
333
       
-
       
      <varlistentry>

     

       
334
       
-
       
        <term>

     

       
335
       
 
       
          <literal>types.submodule</literal>

     

       
336
       
 
       
          <emphasis><literal>o</literal></emphasis>

     

       
337
       
 
       
        </term>

     
···

       
345
       
 
       
            in composed types to create modular options. This is

     

       
346
       
 
       
            equivalent to

     

       
347
       
 
       
            <literal>types.submoduleWith { modules = toList o; shorthandOnlyDefinesConfig = true; }</literal>.

     

       
348
       
-
       
            Submodules are detailed in

     

       
349
       
-
       
            <link linkend="section-option-types-submodule">Submodule</link>.

     

       
350
       
 
       
          </para>

     

       
351
       
 
       
        </listitem>

     

       
352
       
 
       
      </varlistentry>

     
···

       
467
       
 
       
    </variablelist>

     

       
468
       
 
       
  </section>

     

       
469
       
 
       
  <section xml:id="sec-option-types-composed">

     

       
470
       
-
       
    <title>Composed Types</title>

     

       
471
       
 
       
    <para>

     

       
472
       
 
       
      Composed types are types that take a type as parameter.

     

       
473
       
 
       
      <literal>listOf int</literal> and

     
···

       
850
       
 
       
    </variablelist>

     

       
851
       
 
       
  </section>

     

       
852
       
 
       
  <section xml:id="sec-option-types-custom">

     

       
853
       
-
       
    <title>Custom Types</title>

     

       
854
       
 
       
    <para>

     

       
855
       
 
       
      Custom types can be created with the

     

       
856
       
 
       
      <literal>mkOptionType</literal> function. As type creation

     

···

       
6
       
 
       
    in case of multiple value definitions.

     

       
7
       
 
       
  </para>

     

       
8
       
 
       
  <section xml:id="sec-option-types-basic">

     

       
9
       
+
       
    <title>Basic types</title>

     

       
10
       
 
       
    <para>

     

       
11
       
 
       
      Basic types are the simplest available types in the module system.

     

       
12
       
 
       
      Basic types include multiple string types that mainly differ in

     
···

       
46
       
 
       
            A top-level store path. This can be an attribute set

     

       
47
       
 
       
            pointing to a store path, like a derivation or a flake

     

       
48
       
 
       
            input.

     

       
49
       
+
       
          </para>

     

       
50
       
+
       
        </listitem>

     

       
51
       
+
       
      </varlistentry>

     

       
52
       
+
       
      <varlistentry>

     

       
53
       
+
       
        <term>

     

       
54
       
+
       
          <literal>types.enum</literal>

     

       
55
       
+
       
          <emphasis><literal>l</literal></emphasis>

     

       
56
       
+
       
        </term>

     

       
57
       
+
       
        <listitem>

     

       
58
       
+
       
          <para>

     

       
59
       
+
       
            One element of the list

     

       
60
       
+
       
            <emphasis><literal>l</literal></emphasis>, e.g.

     

       
61
       
+
       
            <literal>types.enum [ &quot;left&quot; &quot;right&quot; ]</literal>.

     

       
62
       
+
       
            Multiple definitions cannot be merged.

     

       
63
       
 
       
          </para>

     

       
64
       
 
       
        </listitem>

     

       
65
       
 
       
      </varlistentry>

     
···

       
164
       
 
       
        </listitem>

     

       
165
       
 
       
      </varlistentry>

     

       
166
       
 
       
    </variablelist>

     

       
167
       
+
       
    <section xml:id="sec-option-types-numeric">

     

       
168
       
+
       
      <title>Numeric types</title>

     

       
169
       
+
       
      <variablelist>

     

       
170
       
+
       
        <varlistentry>

     

       
171
       
+
       
          <term>

     

       
172
       
+
       
            <literal>types.int</literal>

     

       
173
       
+
       
          </term>

     

       
174
       
+
       
          <listitem>

     

       
175
       
+
       
            <para>

     

       
176
       
+
       
              A signed integer.

     

       
177
       
+
       
            </para>

     

       
178
       
+
       
          </listitem>

     

       
179
       
+
       
        </varlistentry>

     

       
180
       
+
       
        <varlistentry>

     

       
181
       
+
       
          <term>

     

       
182
       
+
       
            <literal>types.ints.{s8, s16, s32}</literal>

     

       
183
       
+
       
          </term>

     

       
184
       
+
       
          <listitem>

     

       
185
       
+
       
            <para>

     

       
186
       
+
       
              Signed integers with a fixed length (8, 16 or 32 bits).

     

       
187
       
+
       
              They go from −2^n/2 to 2^n/2−1 respectively (e.g.

     

       
188
       
+
       
              <literal>−128</literal> to <literal>127</literal> for 8

     

       
189
       
+
       
              bits).

     

       
190
       
+
       
            </para>

     

       
191
       
+
       
          </listitem>

     

       
192
       
+
       
        </varlistentry>

     

       
193
       
+
       
        <varlistentry>

     

       
194
       
+
       
          <term>

     

       
195
       
+
       
            <literal>types.ints.unsigned</literal>

     

       
196
       
+
       
          </term>

     

       
197
       
+
       
          <listitem>

     

       
198
       
+
       
            <para>

     

       
199
       
+
       
              An unsigned integer (that is &gt;= 0).

     

       
200
       
+
       
            </para>

     

       
201
       
+
       
          </listitem>

     

       
202
       
+
       
        </varlistentry>

     

       
203
       
+
       
        <varlistentry>

     

       
204
       
+
       
          <term>

     

       
205
       
+
       
            <literal>types.ints.{u8, u16, u32}</literal>

     

       
206
       
+
       
          </term>

     

       
207
       
+
       
          <listitem>

     

       
208
       
+
       
            <para>

     

       
209
       
+
       
              Unsigned integers with a fixed length (8, 16 or 32 bits).

     

       
210
       
+
       
              They go from 0 to 2^n−1 respectively (e.g.

     

       
211
       
+
       
              <literal>0</literal> to <literal>255</literal> for 8

     

       
212
       
+
       
              bits).

     

       
213
       
+
       
            </para>

     

       
214
       
+
       
          </listitem>

     

       
215
       
+
       
        </varlistentry>

     

       
216
       
+
       
        <varlistentry>

     

       
217
       
+
       
          <term>

     

       
218
       
+
       
            <literal>types.ints.between</literal>

     

       
219
       
+
       
            <emphasis><literal>lowest highest</literal></emphasis>

     

       
220
       
+
       
          </term>

     

       
221
       
+
       
          <listitem>

     

       
222
       
+
       
            <para>

     

       
223
       
+
       
              An integer between

     

       
224
       
+
       
              <emphasis><literal>lowest</literal></emphasis> and

     

       
225
       
+
       
              <emphasis><literal>highest</literal></emphasis> (both

     

       
226
       
+
       
              inclusive).

     

       
227
       
+
       
            </para>

     

       
228
       
+
       
          </listitem>

     

       
229
       
+
       
        </varlistentry>

     

       
230
       
+
       
        <varlistentry>

     

       
231
       
+
       
          <term>

     

       
232
       
+
       
            <literal>types.ints.positive</literal>

     

       
233
       
+
       
          </term>

     

       
234
       
+
       
          <listitem>

     

       
235
       
+
       
            <para>

     

       
236
       
+
       
              A positive integer (that is &gt; 0).

     

       
237
       
+
       
            </para>

     

       
238
       
+
       
          </listitem>

     

       
239
       
+
       
        </varlistentry>

     

       
240
       
+
       
        <varlistentry>

     

       
241
       
+
       
          <term>

     

       
242
       
+
       
            <literal>types.port</literal>

     

       
243
       
+
       
          </term>

     

       
244
       
+
       
          <listitem>

     

       
245
       
+
       
            <para>

     

       
246
       
+
       
              A port number. This type is an alias to

     

       
247
       
+
       
              <literal>types.ints.u16</literal>.

     

       
248
       
+
       
            </para>

     

       
249
       
+
       
          </listitem>

     

       
250
       
+
       
        </varlistentry>

     

       
251
       
+
       
        <varlistentry>

     

       
252
       
+
       
          <term>

     

       
253
       
+
       
            <literal>types.float</literal>

     

       
254
       
+
       
          </term>

     

       
255
       
+
       
          <listitem>

     

       
256
       
+
       
            <para>

     

       
257
       
+
       
              A floating point number.

     

       
258
       
+
       
            </para>

     

       
259
       
+
       
            <warning>

     

       
260
       
+
       
              <para>

     

       
261
       
+
       
                Converting a floating point number to a string with

     

       
262
       
+
       
                <literal>toString</literal> or <literal>toJSON</literal>

     

       
263
       
+
       
                may result in

     

       
264
       
+
       
                <link xlink:href="https://github.com/NixOS/nix/issues/5733">precision

     

       
265
       
+
       
                loss</link>.

     

       
266
       
+
       
              </para>

     

       
267
       
+
       
            </warning>

     

       
268
       
+
       
          </listitem>

     

       
269
       
+
       
        </varlistentry>

     

       
270
       
+
       
        <varlistentry>

     

       
271
       
+
       
          <term>

     

       
272
       
+
       
            <literal>types.number</literal>

     

       
273
       
+
       
          </term>

     

       
274
       
+
       
          <listitem>

     

       
275
       
+
       
            <para>

     

       
276
       
+
       
              Either a signed integer or a floating point number. No

     

       
277
       
+
       
              implicit conversion is done between the two types, and

     

       
278
       
+
       
              multiple equal definitions will only be merged if they

     

       
279
       
+
       
              have the same type.

     

       
280
       
+
       
            </para>

     

       
281
       
+
       
          </listitem>

     

       
282
       
+
       
        </varlistentry>

     

       
283
       
+
       
        <varlistentry>

     

       
284
       
+
       
          <term>

     

       
285
       
+
       
            <literal>types.numbers.between</literal>

     

       
286
       
+
       
            <emphasis><literal>lowest highest</literal></emphasis>

     

       
287
       
+
       
          </term>

     

       
288
       
+
       
          <listitem>

     

       
289
       
+
       
            <para>

     

       
290
       
+
       
              An integer or floating point number between

     

       
291
       
+
       
              <emphasis><literal>lowest</literal></emphasis> and

     

       
292
       
+
       
              <emphasis><literal>highest</literal></emphasis> (both

     

       
293
       
+
       
              inclusive).

     

       
294
       
+
       
            </para>

     

       
295
       
+
       
          </listitem>

     

       
296
       
+
       
        </varlistentry>

     

       
297
       
+
       
        <varlistentry>

     

       
298
       
+
       
          <term>

     

       
299
       
+
       
            <literal>types.numbers.nonnegative</literal>

     

       
300
       
+
       
          </term>

     

       
301
       
+
       
          <listitem>

     

       
302
       
+
       
            <para>

     

       
303
       
+
       
              A nonnegative integer or floating point number (that is

     

       
304
       
+
       
              &gt;= 0).

     

       
305
       
+
       
            </para>

     

       
306
       
+
       
          </listitem>

     

       
307
       
+
       
        </varlistentry>

     

       
308
       
+
       
        <varlistentry>

     

       
309
       
+
       
          <term>

     

       
310
       
+
       
            <literal>types.numbers.positive</literal>

     

       
311
       
+
       
          </term>

     

       
312
       
+
       
          <listitem>

     

       
313
       
+
       
            <para>

     

       
314
       
+
       
              A positive integer or floating point number (that is &gt;

     

       
315
       
+
       
              0).

     

       
316
       
+
       
            </para>

     

       
317
       
+
       
          </listitem>

     

       
318
       
+
       
        </varlistentry>

     

       
319
       
+
       
      </variablelist>

     

       
320
       
+
       
    </section>

     

       
321
       
+
       
    <section xml:id="sec-option-types-string">

     

       
322
       
+
       
      <title>String types</title>

     

       
323
       
+
       
      <variablelist>

     

       
324
       
+
       
        <varlistentry>

     

       
325
       
+
       
          <term>

     

       
326
       
+
       
            <literal>types.str</literal>

     

       
327
       
+
       
          </term>

     

       
328
       
+
       
          <listitem>

     

       
329
       
+
       
            <para>

     

       
330
       
+
       
              A string. Multiple definitions cannot be merged.

     

       
331
       
+
       
            </para>

     

       
332
       
+
       
          </listitem>

     

       
333
       
+
       
        </varlistentry>

     

       
334
       
+
       
        <varlistentry>

     

       
335
       
+
       
          <term>

     

       
336
       
+
       
            <literal>types.separatedString</literal>

     

       
337
       
+
       
            <emphasis><literal>sep</literal></emphasis>

     

       
338
       
+
       
          </term>

     

       
339
       
+
       
          <listitem>

     

       
340
       
+
       
            <para>

     

       
341
       
+
       
              A string. Multiple definitions are concatenated with

     

       
342
       
+
       
              <emphasis><literal>sep</literal></emphasis>, e.g.

     

       
343
       
+
       
              <literal>types.separatedString &quot;|&quot;</literal>.

     

       
344
       
+
       
            </para>

     

       
345
       
+
       
          </listitem>

     

       
346
       
+
       
        </varlistentry>

     

       
347
       
+
       
        <varlistentry>

     

       
348
       
+
       
          <term>

     

       
349
       
+
       
            <literal>types.lines</literal>

     

       
350
       
+
       
          </term>

     

       
351
       
+
       
          <listitem>

     

       
352
       
+
       
            <para>

     

       
353
       
+
       
              A string. Multiple definitions are concatenated with a new

     

       
354
       
+
       
              line <literal>&quot;\n&quot;</literal>.

     

       
355
       
+
       
            </para>

     

       
356
       
+
       
          </listitem>

     

       
357
       
+
       
        </varlistentry>

     

       
358
       
+
       
        <varlistentry>

     

       
359
       
+
       
          <term>

     

       
360
       
+
       
            <literal>types.commas</literal>

     

       
361
       
+
       
          </term>

     

       
362
       
+
       
          <listitem>

     

       
363
       
+
       
            <para>

     

       
364
       
+
       
              A string. Multiple definitions are concatenated with a

     

       
365
       
+
       
              comma <literal>&quot;,&quot;</literal>.

     

       
366
       
+
       
            </para>

     

       
367
       
+
       
          </listitem>

     

       
368
       
+
       
        </varlistentry>

     

       
369
       
+
       
        <varlistentry>

     

       
370
       
+
       
          <term>

     

       
371
       
+
       
            <literal>types.envVar</literal>

     

       
372
       
+
       
          </term>

     

       
373
       
+
       
          <listitem>

     

       
374
       
+
       
            <para>

     

       
375
       
+
       
              A string. Multiple definitions are concatenated with a

     

       
376
       
+
       
              colon <literal>&quot;:&quot;</literal>.

     

       
377
       
+
       
            </para>

     

       
378
       
+
       
          </listitem>

     

       
379
       
+
       
        </varlistentry>

     

       
380
       
+
       
        <varlistentry>

     

       
381
       
+
       
          <term>

     

       
382
       
+
       
            <literal>types.strMatching</literal>

     

       
383
       
+
       
          </term>

     

       
384
       
+
       
          <listitem>

     

       
385
       
+
       
            <para>

     

       
386
       
+
       
              A string matching a specific regular expression. Multiple

     

       
387
       
+
       
              definitions cannot be merged. The regular expression is

     

       
388
       
+
       
              processed using <literal>builtins.match</literal>.

     

       
389
       
+
       
            </para>

     

       
390
       
+
       
          </listitem>

     

       
391
       
+
       
        </varlistentry>

     

       
392
       
+
       
      </variablelist>

     

       
393
       
+
       
    </section>

     

       
394
       
 
       
  </section>

     

       
395
       
+
       
  <section xml:id="sec-option-types-submodule">

     

       
396
       
+
       
    <title>Submodule types</title>

     

       
397
       
 
       
    <para>

     

       
398
       
+
       
      Submodules are detailed in

     

       
399
       
+
       
      <link linkend="section-option-types-submodule">Submodule</link>.

     

       
400
       
 
       
    </para>

     

       
401
       
 
       
    <variablelist>

     

       
402
       
 
       
      <varlistentry>

     

       
403
       
 
       
        <term>

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
404
       
 
       
          <literal>types.submodule</literal>

     

       
405
       
 
       
          <emphasis><literal>o</literal></emphasis>

     

       
406
       
 
       
        </term>

     
···

       
414
       
 
       
            in composed types to create modular options. This is

     

       
415
       
 
       
            equivalent to

     

       
416
       
 
       
            <literal>types.submoduleWith { modules = toList o; shorthandOnlyDefinesConfig = true; }</literal>.

     

       
0
       
 
       

     

       
0
       
 
       

     

       
417
       
 
       
          </para>

     

       
418
       
 
       
        </listitem>

     

       
419
       
 
       
      </varlistentry>

     
···

       
534
       
 
       
    </variablelist>

     

       
535
       
 
       
  </section>

     

       
536
       
 
       
  <section xml:id="sec-option-types-composed">

     

       
537
       
+
       
    <title>Composed types</title>

     

       
538
       
 
       
    <para>

     

       
539
       
 
       
      Composed types are types that take a type as parameter.

     

       
540
       
 
       
      <literal>listOf int</literal> and

     
···

       
917
       
 
       
    </variablelist>

     

       
918
       
 
       
  </section>

     

       
919
       
 
       
  <section xml:id="sec-option-types-custom">

     

       
920
       
+
       
    <title>Custom types</title>

     

       
921
       
 
       
    <para>

     

       
922
       
 
       
      Custom types can be created with the

     

       
923
       
 
       
      <literal>mkOptionType</literal> function. As type creation

     

···

       
11
       
 
       
    addCheck (listOf x) (y: length y == 2)

     

       
12
       
 
       
    // { description = "pair of ${x.description}"; };

     

       
13
       
 
       


     

       
14
       
-
       
  floatBetween = a: b: with types;

     

       
15
       
-
       
    let

     

       
16
       
-
       
      # toString prints floats with hardcoded high precision

     

       
17
       
-
       
      floatToString = f: builtins.toJSON f;

     

       
18
       
-
       
    in

     

       
19
       
-
       
      addCheck float (x: x <= b && x >= a)

     

       
20
       
-
       
      // { description = "a floating point number in " +

     

       
21
       
-
       
                         "range [${floatToString a}, ${floatToString b}]"; };

     

       
22
       
-
       


     

       
23
       
 
       
  mkDefaultAttrs = mapAttrs (n: v: mkDefault v);

     

       
24
       
 
       


     

       
25
       
 
       
  # Basically a tinkered lib.generators.mkKeyValueDefault

     
···

       
93
       
 
       
    };

     

       
94
       
 
       


     

       
95
       
 
       
    fadeSteps = mkOption {

     

       
96
       
-
       
      type = pairOf (floatBetween 0.01 1);

     

       
97
       
 
       
      default = [ 0.028 0.03 ];

     

       
98
       
 
       
      example = [ 0.04 0.04 ];

     

       
99
       
 
       
      description = lib.mdDoc ''

     
···

       
133
       
 
       
    };

     

       
134
       
 
       


     

       
135
       
 
       
    shadowOpacity = mkOption {

     

       
136
       
-
       
      type = floatBetween 0 1;

     

       
137
       
 
       
      default = 0.75;

     

       
138
       
 
       
      example = 0.8;

     

       
139
       
 
       
      description = lib.mdDoc ''

     
···

       
156
       
 
       
    };

     

       
157
       
 
       


     

       
158
       
 
       
    activeOpacity = mkOption {

     

       
159
       
-
       
      type = floatBetween 0 1;

     

       
160
       
 
       
      default = 1.0;

     

       
161
       
 
       
      example = 0.8;

     

       
162
       
 
       
      description = lib.mdDoc ''

     
···

       
165
       
 
       
    };

     

       
166
       
 
       


     

       
167
       
 
       
    inactiveOpacity = mkOption {

     

       
168
       
-
       
      type = floatBetween 0.1 1;

     

       
169
       
 
       
      default = 1.0;

     

       
170
       
 
       
      example = 0.8;

     

       
171
       
 
       
      description = lib.mdDoc ''

     
···

       
174
       
 
       
    };

     

       
175
       
 
       


     

       
176
       
 
       
    menuOpacity = mkOption {

     

       
177
       
-
       
      type = floatBetween 0 1;

     

       
178
       
 
       
      default = 1.0;

     

       
179
       
 
       
      example = 0.8;

     

       
180
       
 
       
      description = lib.mdDoc ''

     

···

       
11
       
 
       
    addCheck (listOf x) (y: length y == 2)

     

       
12
       
 
       
    // { description = "pair of ${x.description}"; };

     

       
13
       
 
       


     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
14
       
 
       
  mkDefaultAttrs = mapAttrs (n: v: mkDefault v);

     

       
15
       
 
       


     

       
16
       
 
       
  # Basically a tinkered lib.generators.mkKeyValueDefault

     
···

       
84
       
 
       
    };

     

       
85
       
 
       


     

       
86
       
 
       
    fadeSteps = mkOption {

     

       
87
       
+
       
      type = pairOf (types.numbers.between 0.01 1);

     

       
88
       
 
       
      default = [ 0.028 0.03 ];

     

       
89
       
 
       
      example = [ 0.04 0.04 ];

     

       
90
       
 
       
      description = lib.mdDoc ''

     
···

       
124
       
 
       
    };

     

       
125
       
 
       


     

       
126
       
 
       
    shadowOpacity = mkOption {

     

       
127
       
+
       
      type = types.numbers.between 0 1;

     

       
128
       
 
       
      default = 0.75;

     

       
129
       
 
       
      example = 0.8;

     

       
130
       
 
       
      description = lib.mdDoc ''

     
···

       
147
       
 
       
    };

     

       
148
       
 
       


     

       
149
       
 
       
    activeOpacity = mkOption {

     

       
150
       
+
       
      type = types.numbers.between 0 1;

     

       
151
       
 
       
      default = 1.0;

     

       
152
       
 
       
      example = 0.8;

     

       
153
       
 
       
      description = lib.mdDoc ''

     
···

       
156
       
 
       
    };

     

       
157
       
 
       


     

       
158
       
 
       
    inactiveOpacity = mkOption {

     

       
159
       
+
       
      type = types.numbers.between 0.1 1;

     

       
160
       
 
       
      default = 1.0;

     

       
161
       
 
       
      example = 0.8;

     

       
162
       
 
       
      description = lib.mdDoc ''

     
···

       
165
       
 
       
    };

     

       
166
       
 
       


     

       
167
       
 
       
    menuOpacity = mkOption {

     

       
168
       
+
       
      type = types.numbers.between 0 1;

     

       
169
       
 
       
      default = 1.0;

     

       
170
       
 
       
      example = 0.8;

     

       
171
       
 
       
      description = lib.mdDoc ''