-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathsus-choice_type-Choice.html
1003 lines (958 loc) · 69 KB
/
sus-choice_type-Choice.html
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
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!DOCTYPE html>
<html>
<head>
<meta content="text/html;charset=utf-8" http-equiv="Content-Type"></meta>
<meta name="generator" content="subdoc"></meta>
<meta name="viewport" content="width=device-width, initial-scale=1"></meta>
<meta property="og:type" content="website"></meta>
<meta property="og:site_name" content="Subspace"></meta>
<meta property="og:url" content="https://suslib.cc/sus-choice_type-Choice.html"></meta>
<title>sus::choice_type::Choice - Subspace</title>
<meta property="og:title" content="sus::choice_type::Choice - Subspace"></meta>
<meta name="description" content="A tagged union, or sum type."></meta>
<meta property="og:description" content="A tagged union, or sum type."></meta>
<script src="https://unpkg.com/lunr/lunr.js"></script>
<script src="./search_db.js"></script>
<script>
// Delayed loading of whatever was in the search box.
var searchDelayLoad;
// The search box's dynamic behaviour.
document.addEventListener("keyup", e => {
if (e.key === 's') {
document.querySelector('.search-input').focus();
}
if (e.key === 'Escape') {
document.querySelector('.search-input').blur();
navigateToSearch(null);
e.preventDefault();
}
});
function navigateToSearch(query) {
window.clearTimeout(searchDelayLoad);
searchDelayLoad = null;
let without_search =
window.location.origin + window.location.pathname;
if (query) {
window.history.replaceState(null, "",
without_search + "?" + `search=${query}`);
} else {
window.history.replaceState(null, "", without_search);
}
maybeShowSearchResults();
}
addEventListener("load", event => {
document.querySelector(".search-input").oninput = (e) => {
window.clearTimeout(searchDelayLoad);
searchDelayLoad = window.setTimeout(() => {
navigateToSearch(e.target.value);
}, 1000);
};
document.querySelector(".search-input").onkeypress = (e) => {
if (e.key == "Enter") {
navigateToSearch(e.target.value);
e.preventDefault();
}
};
var searchPlaceholder;
document.querySelector(".search-input").onfocus = (e) => {
searchPlaceholder = e.target.placeholder;
e.target.placeholder = "Type your search here.";
navigateToSearch(e.target.value);
};
document.querySelector(".search-input").onblur = (e) => {
e.target.placeholder = searchPlaceholder;
searchPlaceholder = null;
};
});
// Show or hide any DOM element.
function showHide(selector, show) {
if (show)
document.querySelector(selector).classList.remove("hidden");
else
document.querySelector(selector).classList.add("hidden");
}
function searchQuery() {
const params = new Proxy(
new URLSearchParams(window.location.search), {
get: (searchParams, prop) => searchParams.get(prop),
}
);
return params.search;
}
// Showing search results.
async function populateSearchResults(loaded) {
const search_db = loaded.search_db;
const idx = loaded.idx;
// lunrjs treats `:` specially and `::` breaks the query syntax, so
// just split into two words.
const query = searchQuery().split("::").join(" ");
let content = '';
try {
const results = idx.search(query);
for (r of results) {
const item = search_db[r.ref];
const type = item.type;
const url = item.url;
const name = item.name;
const full_name = item.full_name;
const summmary = item.summary ? item.summary : "";
content += `\
<a class="search-results-link" href="${url}">
<span class="search-results-type"><div>${type}</div></span>\
<span class="search-results-name"><div>${full_name}</div></span>\
<span class="search-results-summary"><div>${summmary}</div></span>\
</a>\
`
}
} catch (err) {
content +=
`<div class="search-error">Search error: ${err.message}</div>`;
}
let content_elem = document.querySelector(".search-results-content");
content_elem.innerHTML = content;
let header_elem = document.querySelector(".search-results-header");
header_elem.innerText = "Search results";
}
var cache_idx;
// Searching via https://lunrjs.com.
//
// Load the JSON search database, which will be turned into a search
// index. Returns an object with two fields:
// - search_db: the contents of the search.json file.
// - idx: the lunr search index.
// Documented at https://lunrjs.com/docs/lunr.Index.html.
async function loadSearchIndex() {
// This is not widely supported yet (not on Safari), so instead we
// turned the json file into a js file that sets a global variable. :|
//async function load_search_db() {
// let x = await import('./search.json', {
// with: {type: 'json'}
// });
// return x.default;
//}
async function load_idx(search_db) {
let idx = lunr(function () {
this.ref('index');
this.field('name', {
'boost': 2,
editDistance: 0
});
this.field('full_name', {
'boost': 2,
editDistance: 2
});
this.field('split_name', {
'boost': 0.5,
editDistance: 2
});
// No stemming and no stopwords (like `into` and `from`).
this.pipeline = new lunr.Pipeline();
this.searchPipeline = new lunr.Pipeline();
// Queries are split by these tokens.
const splitBy = /(\s+|_+|(::)+)/
this.use(builder => {
function splitTokens(token) {
return token.toString().split(splitBy).map(str => {
return token.clone().update(() => { return str })
})
}
lunr.Pipeline.registerFunction(splitTokens, 'splitTokens')
builder.searchPipeline.add(splitTokens)
});
search_db.forEach(item => {
const weights = {
"concept": 3,
"class": 2,
"struct": 2,
"union": 2,
"function": 1.75,
"variable": 1.75,
"namespace": 1.2,
"method": 1,
"constructor": 1,
"macro": 1,
"project": 1,
"field": 0.9,
"conversion": 0.5,
"type alias": 0.5,
"concept alias": 0.5,
"function alias": 0.5,
"method alias": 0.5,
"enum value alias": 0.5,
"variable alias": 0.5,
}
let weight = weights[item.type];
if (!weight) {
console.log(`WARNING: search item type ${item.type} ` +
`has no weight defined`);
weight = 1;
}
this.add(item, {
'boost': weight
})
}, this);
});
let out = {};
out.search_db = search_db;
out.idx = idx;
return out;
};
if (!cache_idx) {
cache_idx = await load_idx(g_search_db);
}
return cache_idx;
}
// If there's a search query, hide the other content and asynchronously
// show the search results. Otherwise, hide search content and show the
// rest immediately.
function maybeShowSearchResults() {
const query = searchQuery();
if (query) {
showHide(".main-content", false);
let input = document.querySelector(".search-input");
input.value = query;
let header_elem = document.querySelector(".search-results-header");
header_elem.innerText = "Loading search results...";
let content_ele = document.querySelector(".search-results-content");
content_ele.innerText = "";
loadSearchIndex().then(populateSearchResults)
} else {
showHide(".main-content", true);
let header_elem = document.querySelector(".search-results-header");
header_elem.innerText = "";
let content_ele = document.querySelector(".search-results-content");
content_ele.innerText = "";
}
}
</script>
<link rel="stylesheet" href="subdoc-test-style.css">
<link rel="icon" type="image/png" href="logo.png">
<link rel="alternate icon" type="image/png" href="logo32.png">
<meta property="og:image" content="logo.png"></meta>
</head>
<body>
<nav class="topbar">
<button class="sidebar-menu-button" onclick="let e = document.getElementsByClassName('sidebar')[0];e.classList.toggle('shown');">
☰
</button>
<a class="topbar-logo-link" href="index.html"><div class="topbar-logo-border">
<img class="topbar-logo" src="logo.png"></img>
</div></a>
<span class="topbar-text-area">
<span class="topbar-title">
<a href="#">Choice</a>
</span>
</span>
</nav>
<nav class="sidebar">
<a class="sidebar-logo-link" href="index.html"><div class="sidebar-logo-border">
<img class="sidebar-logo" src="logo.png"></img>
</div></a>
<div class="sidebar-pretitle sidebar-text">
class
</div>
<div class="sidebar-title sidebar-text">
<a href="#">Choice</a>
</div>
<div class="sidebar-subtitle sidebar-text">
</div>
<div class="sidebar-links sidebar-text">
<ul>
<li>
<a class="sidebar-header" href="#static-methods">Static Methods</a>
</li>
<li>
<a class="sidebar-item" href="sus-choice_type-Choice.html#method.Choice.move">Choice</a>
</li>
<li>
<a class="sidebar-item" href="sus-choice_type-Choice.html#method.Choice.copy">Choice</a>
</li>
<li>
<a class="sidebar-item" href="sus-choice_type-Choice.html#method.with">with</a>
</li>
<li>
<a class="sidebar-header" href="#methods">Methods</a>
</li>
<li>
<a class="sidebar-item" href="sus-choice_type-Choice.html#method.as">as</a>
</li>
<li>
<a class="sidebar-item" href="sus-choice_type-Choice.html#method.as_mut">as_mut</a>
</li>
<li>
<a class="sidebar-item" href="sus-choice_type-Choice.html#method.clone">clone</a>
</li>
<li>
<a class="sidebar-item" href="sus-choice_type-Choice.html#method.get">get</a>
</li>
<li>
<a class="sidebar-item" href="sus-choice_type-Choice.html#method.get_mut">get_mut</a>
</li>
<li>
<a class="sidebar-item" href="sus-choice_type-Choice.html#method.get_unchecked">get_unchecked</a>
</li>
<li>
<a class="sidebar-item" href="sus-choice_type-Choice.html#method.get_unchecked_mut">get_unchecked_mut</a>
</li>
<li>
<a class="sidebar-item" href="sus-choice_type-Choice.html#method.into_inner">into_inner</a>
</li>
<li>
<a class="sidebar-item" href="sus-choice_type-Choice.html#method.set">set</a>
</li>
<li>
<a class="sidebar-item" href="sus-choice_type-Choice.html#method.which">which</a>
</li>
<li>
<a class="sidebar-header" href="#conversions">Conversions</a>
</li>
<li>
<a class="sidebar-item" href="sus-choice_type-Choice.html#method.operator TagsType">operator TagsType</a>
</li>
<li>
<a class="sidebar-header" href="#operators">Operators</a>
</li>
<li>
<a class="sidebar-item" href="sus-choice_type-Choice.html#method.operator=.move">operator=</a>
</li>
<li>
<a class="sidebar-item" href="sus-choice_type-Choice.html#method.operator=.copy">operator=</a>
</li>
</ul>
</div>
</nav>
<main>
<nav class="search-nav">
<form class="search-form">
<input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press 'S' to search...">
</input>
</form>
</nav>
<section class="search-results">
<h1 class="search-results-header">
</h1>
<div class="search-results-content">
</div>
</section>
<section class="main-content">
<script>maybeShowSearchResults()</script>
<div class="type record class">
<div class="section overview">
<h1 class="section-header">
<span>
Class
</span>
<a class="project-name" href="index.html">Subspace</a>
<span class="namespace-dots">::</span>
<a class="namespace-name" href="namespace.sus.html">sus</a>
<span class="namespace-dots">::</span>
<a class="namespace-name" href="sus-namespace.choice_type.html">choice_type</a>
<span class="namespace-dots">::</span>
<a class="type-name" href="#">Choice</a>
</h1>
<div class="type-signature"><div class="src rightside"><a href="https://github.com/chromium/subspace/blob/main/sus/choice/choice.h#L188">source</a></div><span class="class">
class
</span><span class="type-name">
Choice
</span><span class="final">
final
</span><div class="record-body">
{ ... };
</div></div>
<div class="description long">
<p>A tagged union, or sum type.</p>
<p>A <code>Choice</code> is always set to one of its <code>Tags</code> values, and each tag has zero
or more types attached to it as data values.</p>
<p><code>Choice</code> can be thought of as a combination of an <a href="https://en.cppreference.com/w/cpp/language/enum"><code>enum</code></a> and a
<a href="https://en.cppreference.com/w/cpp/utility/variant"><code>std::variant</code></a>, and
typically the <code>Tags</code> are specified to be values in an <code>enum</code>.</p>
<p>A <code>Choice</code> always has an active member, as the tag must be specified at
construction, and the asociated values for the tag are always set as they
must be set when the tag is specified. This means a <code>Choice</code> is always in a
fully specified state, or it is moved-from. Once it is moved from it may not
be used except to be re-initialized.</p>
<p>Use the <code>sus_choice_types()</code> macro to specify the types in a <code>Choice</code> type.</p>
<p>To access the values in <code>Choice</code>, the current tag must be specified as a
template parameter, and it will be checked for correctness. When it does not
match, the <code>Choice</code> method will panic.</p>
<ul>
<li><a href="sus-choice_type-Choice.html#method.as"><code>as<Tag>()</code></a> gives const access to all the
values attached to the tag.</li>
<li><a href="sus-choice_type-Choice.html#method.as_mut"><code>as_mut<Tag>()</code></a> gives mutable access
to all the values attached to the tag. It is only callable on mutable
<code>Choice</code>.</li>
<li><a href="sus-choice_type-Choice.html#method.into_inner"><code>into_inner<Tag>()</code></a> moves all
values attached to the tag out of the <code>Choice</code> and marks the <code>Choice</code> as
moved-from. It is only callable on an rvalue <code>Choice.</code></li>
<li><a href="sus-choice_type-Choice.html#method.get"><code>get<Tag>()</code></a> returns a const reference
to the values attached to the tag if its currently active, and returns
<code>None</code> if the tag is not active.</li>
<li><a href="sus-choice_type-Choice.html#method.get"><code>get_mut<Tag>()</code></a> returns a mutable
reference to the values attached to the tag if its currently active, and
returns <code>None</code> if the tag is not active.</li>
</ul>
<h1><a name="examples" href="#examples">Examples</a></h1>
<p>This <code>Choice</code> holds either a <a href="sus-num-u64.html"><code>u64</code></a> with
the <code>First</code> tag or a <a href="sus-num-u32.html"><code>u32</code></a> with the <code>Second</code> tag.</p>
<pre><code><span class="keyword">enum</span> <span class="keyword">class</span> Order <span class="punct">{</span> First<span class="punct">,</span> Second <span class="punct">}</span><span class="punct">;</span>
<span class="keyword">using</span> EitherOr <span class="punct">=</span> Choice<span class="punct"><</span>sus_choice_types<span class="punct">(</span>
<span class="punct">(</span>Order::First<span class="punct">,</span> u64<span class="punct">)</span><span class="punct">,</span>
<span class="punct">(</span>Order::Second<span class="punct">,</span> u32<span class="punct">)</span>
<span class="punct">)</span><span class="punct">></span><span class="punct">;</span>
</code></pre>
<p>A <code>Choice</code> tag may be associated with no values by making its type <code>void</code> or
may be associated with more than one type in which case all access will be
done with a <a href="sus-tuple_type-Tuple.html"><code>Tuple</code></a>.</p>
<pre><code><span class="keyword">enum</span> <span class="keyword">class</span> Order <span class="punct">{</span> First<span class="punct">,</span> Second <span class="punct">}</span><span class="punct">;</span>
<span class="keyword">using</span> EitherOr <span class="punct">=</span> Choice<span class="punct"><</span>sus_choice_types<span class="punct">(</span>
<span class="punct">(</span>Order::First<span class="punct">,</span> <span class="keyword">void</span><span class="punct">)</span><span class="punct">,</span>
<span class="punct">(</span>Order::Second<span class="punct">,</span> std::string<span class="punct">,</span> i32<span class="punct">)</span>
<span class="punct">)</span><span class="punct">></span><span class="punct">;</span>
<span class="keyword">auto</span> e1 <span class="punct">=</span> EitherOr::with<span class="punct"><</span>Order::First<span class="punct">></span><span class="punct">(</span><span class="punct">)</span><span class="punct">;</span>
<span class="keyword">auto</span> e2 <span class="punct">=</span> EitherOr::with<span class="punct"><</span>Order::Second<span class="punct">></span><span class="punct">(</span><span class="string">"text"</span><span class="punct">,</span> 123<span class="punct">)</span><span class="punct">;</span>
</code></pre>
<p>The <code>Choice</code> type can be used in a <code>switch</code>, with each case being one of its
possible tag values. Within each tag case block, the values can be pulled
out of the <code>Choice</code> with <a href="sus-choice_type-Choice.html#method.as"><code>as</code></a> in a
type-safe and memory-safe way.</p>
<pre><code><span class="keyword">enum</span> <span class="keyword">class</span> Order <span class="punct">{</span> First<span class="punct">,</span> Second <span class="punct">}</span><span class="punct">;</span>
<span class="keyword">using</span> EitherOr <span class="punct">=</span> Choice<span class="punct"><</span>sus_choice_types<span class="punct">(</span>
<span class="punct">(</span>Order::First<span class="punct">,</span> u64<span class="punct">)</span><span class="punct">,</span>
<span class="punct">(</span>Order::Second<span class="punct">,</span> std::string<span class="punct">,</span> i32<span class="punct">)</span>
<span class="punct">)</span><span class="punct">></span><span class="punct">;</span>
<span class="keyword">auto</span> e <span class="punct">=</span> EitherOr::with<span class="punct"><</span>Order::Second<span class="punct">></span><span class="punct">(</span><span class="string">"hello worl"</span><span class="punct">,</span> 0xd<span class="punct">)</span><span class="punct">;</span>
<span class="keyword">switch</span> <span class="punct">(</span>e<span class="punct">)</span> <span class="punct">{</span>
<span class="keyword">case</span> Order::First: <span class="punct">{</span>
<span class="keyword">const</span> <span class="keyword">auto</span><span class="punct">&</span> i <span class="punct">=</span> e<span class="punct">.</span>as<span class="punct"><</span>Order::First<span class="punct">></span><span class="punct">(</span><span class="punct">)</span><span class="punct">;</span>
<span class="comment">// We don't get here.</span>
fmt::println<span class="punct">(</span><span class="string">"First has u64 {}"</span><span class="punct">,</span> i<span class="punct">)</span><span class="punct">;</span>
<span class="keyword">break</span><span class="punct">;</span>
<span class="punct">}</span>
<span class="keyword">case</span> Order::Second: <span class="punct">{</span>
<span class="keyword">const</span> <span class="keyword">auto</span><span class="punct">&</span> <span class="punct">[</span>s<span class="punct">,</span> i<span class="punct">]</span> <span class="punct">=</span> e<span class="punct">.</span>as<span class="punct"><</span>Order::Second<span class="punct">></span><span class="punct">(</span><span class="punct">)</span><span class="punct">;</span>
<span class="comment">// Prints "Second has hello world".</span>
fmt::println<span class="punct">(</span><span class="string">"Second has {}{:x}"</span><span class="punct">,</span> s<span class="punct">,</span> i<span class="punct">)</span><span class="punct">;</span>
<span class="keyword">break</span><span class="punct">;</span>
<span class="punct">}</span>
<span class="punct">}</span>
</code></pre>
<p><code>Choice</code> will re-export the tag value type as a nested <code>Tag</code> subtype. This
allows access to the Choice's values though <code>MyChoiceType::Tag::Name</code>.</p>
<pre><code><span class="keyword">enum</span> <span class="keyword">class</span> Order <span class="punct">{</span> First<span class="punct">,</span> Second <span class="punct">}</span><span class="punct">;</span>
<span class="keyword">using</span> EitherOr <span class="punct">=</span> Choice<span class="punct"><</span>sus_choice_types<span class="punct">(</span>
<span class="punct">(</span>Order::First<span class="punct">,</span> u64<span class="punct">)</span><span class="punct">,</span>
<span class="punct">(</span>Order::Second<span class="punct">,</span> u32<span class="punct">)</span>
<span class="punct">)</span><span class="punct">></span><span class="punct">;</span>
<span class="keyword">auto</span> x <span class="punct">=</span> EitherOr::with<span class="punct"><</span>EitherOr::Tag::First<span class="punct">></span><span class="punct">(</span>987u<span class="punct">)</span><span class="punct">;</span>
</code></pre>
</div>
</div>
<div class="section methods static">
<h1 class="section-header">
<a name="static-methods" href="#static-methods">Static Methods</a>
</h1>
<div class="section-items">
<div class="overload-set item-name">
<div class="overload">
<div class="function-signature"><div class="src rightside"><a href="https://github.com/chromium/subspace/blob/main/sus/choice/choice.h#L367">source</a></div><a name="method.Choice.move"></a><a class="function-name" href="sus-choice_type-Choice.html#method.Choice.move">Choice</a>(<a class="type-name" href="sus-choice_type-Choice.html" title="sus::choice_type::Choice">Choice</a><sus::choice_type::__private::TypeList<Ts...>, Tags...>&& o)<div class="requires">
<span class="requires-keyword keyword">
requires
</span>
<div class="requires-constraint"><pre class="requires-constraint-line">(... && ::sus::mem::Move<Ts>)</pre></div>
<div class="requires-constraint"><pre class="requires-constraint-line">(std::is_trivially_move_constructible_v<TagsType> && ... &&</pre><pre class="requires-constraint-line"> std::is_trivially_move_constructible_v<Ts>)</pre></div>
</div></div>
</div>
<div class="overload">
<div class="function-signature"><div class="src rightside"><a href="https://github.com/chromium/subspace/blob/main/sus/choice/choice.h#L367">source</a></div><a name="method.Choice.move"></a><a class="function-name" href="sus-choice_type-Choice.html#method.Choice.move">Choice</a>(<a class="type-name" href="sus-choice_type-Choice.html" title="sus::choice_type::Choice">Choice</a><sus::choice_type::__private::TypeList<Ts...>, Tags...>&& o)<div class="requires">
<span class="requires-keyword keyword">
requires
</span>
<div class="requires-constraint"><pre class="requires-constraint-line">(... && ::sus::mem::Move<Ts>)</pre></div>
<div class="requires-constraint"><pre class="requires-constraint-line">!(std::is_trivially_move_constructible_v<TagsType> && ... &&</pre><pre class="requires-constraint-line"> std::is_trivially_move_constructible_v<Ts>)</pre></div>
</div></div>
</div>
<div class="overload">
<div class="function-signature"><div class="src rightside"><a href="https://github.com/chromium/subspace/blob/main/sus/choice/choice.h#L367">source</a></div><a name="method.Choice.move"></a><a class="function-name" href="sus-choice_type-Choice.html#method.Choice.move">Choice</a>(<a class="type-name" href="sus-choice_type-Choice.html" title="sus::choice_type::Choice">Choice</a><sus::choice_type::__private::TypeList<Ts...>, Tags...>&& o)<div class="requires">
<span class="requires-keyword keyword">
requires
</span>
<div class="requires-constraint"><pre class="requires-constraint-line">!(... && ::sus::mem::Move<Ts>)</pre></div>
</div><div class="deleted">
deleted
</div></div>
</div>
</div>
<div class="description long">
<p>Move constructor.</p>
<p><code>Choice</code> satisfies <a href="sus-mem-Move.html"><code>Move</code></a> when the types it holds all
satisfy <a href="sus-mem-Move.html"><code>Move</code></a>.</p>
</div>
<div class="overload-set item-name">
<div class="overload">
<div class="function-signature"><div class="src rightside"><a href="https://github.com/chromium/subspace/blob/main/sus/choice/choice.h#L426">source</a></div><a name="method.Choice.copy"></a><a class="function-name" href="sus-choice_type-Choice.html#method.Choice.copy">Choice</a>(<span class="const">const</span> <a class="type-name" href="sus-choice_type-Choice.html" title="sus::choice_type::Choice">Choice</a><sus::choice_type::__private::TypeList<Ts...>, Tags...>& o)<div class="requires">
<span class="requires-keyword keyword">
requires
</span>
<div class="requires-constraint"><pre class="requires-constraint-line">(... && ::sus::mem::Copy<Ts>)</pre></div>
<div class="requires-constraint"><pre class="requires-constraint-line">(std::is_trivially_copy_constructible_v<TagsType> && ... &&</pre><pre class="requires-constraint-line"> std::is_trivially_copy_constructible_v<Ts>)</pre></div>
</div></div>
</div>
<div class="overload">
<div class="function-signature"><div class="src rightside"><a href="https://github.com/chromium/subspace/blob/main/sus/choice/choice.h#L426">source</a></div><a name="method.Choice.copy"></a><a class="function-name" href="sus-choice_type-Choice.html#method.Choice.copy">Choice</a>(<span class="const">const</span> <a class="type-name" href="sus-choice_type-Choice.html" title="sus::choice_type::Choice">Choice</a><sus::choice_type::__private::TypeList<Ts...>, Tags...>& o)<div class="requires">
<span class="requires-keyword keyword">
requires
</span>
<div class="requires-constraint"><pre class="requires-constraint-line">(... && ::sus::mem::Copy<Ts>)</pre></div>
<div class="requires-constraint"><pre class="requires-constraint-line">!(std::is_trivially_copy_constructible_v<TagsType> && ... &&</pre><pre class="requires-constraint-line"> std::is_trivially_copy_constructible_v<Ts>)</pre></div>
</div></div>
</div>
<div class="overload">
<div class="function-signature"><div class="src rightside"><a href="https://github.com/chromium/subspace/blob/main/sus/choice/choice.h#L426">source</a></div><a name="method.Choice.copy"></a><a class="function-name" href="sus-choice_type-Choice.html#method.Choice.copy">Choice</a>(<span class="const">const</span> <a class="type-name" href="sus-choice_type-Choice.html" title="sus::choice_type::Choice">Choice</a><sus::choice_type::__private::TypeList<Ts...>, Tags...>& o)<div class="requires">
<span class="requires-keyword keyword">
requires
</span>
<div class="requires-constraint"><pre class="requires-constraint-line">!(... && ::sus::mem::Copy<Ts>)</pre></div>
</div><div class="deleted">
deleted
</div></div>
</div>
</div>
<div class="description long">
<p>Copy constructor.</p>
<p><code>Choice</code> satisfies <a href="sus-mem-Copy.html"><code>Copy</code></a> when the types it holds all
satisfy <a href="sus-mem-Copy.html"><code>Copy</code></a>.</p>
</div>
<div class="overload-set item-name">
<div class="overload">
<div class="function-signature"><div class="src rightside"><a href="https://github.com/chromium/subspace/blob/main/sus/choice/choice.h#L297">source</a></div><a name="method.with"></a><div class="template">template <TagsType V></div><span class="static">static</span> <span class="function-auto">auto</span> <a class="function-name" href="sus-choice_type-Choice.html#method.with">with</a>() -> <a class="type-name" href="sus-choice_type-Choice.html" title="sus::choice_type::Choice">Choice</a><sus::choice_type::__private::TypeList<Ts...>, Tags...><div class="requires">
<span class="requires-keyword keyword">
requires
</span>
<div class="requires-constraint"><pre class="requires-constraint-line">__private::StorageCount<StorageTypeOfTag<V>> == 0u</pre></div>
</div></div>
</div>
<div class="overload">
<div class="function-signature"><div class="src rightside"><a href="https://github.com/chromium/subspace/blob/main/sus/choice/choice.h#L297">source</a></div><a name="method.with"></a><div class="template">template <TagsType V, class U></div><span class="static">static</span> <span class="function-auto">auto</span> <a class="function-name" href="sus-choice_type-Choice.html#method.with">with</a>(U&& value) -> <a class="type-name" href="sus-choice_type-Choice.html" title="sus::choice_type::Choice">Choice</a><sus::choice_type::__private::TypeList<Ts...>, Tags...><div class="requires">
<span class="requires-keyword keyword">
requires
</span>
<div class="requires-constraint"><pre class="requires-constraint-line">__private::StorageCount<StorageTypeOfTag<V>> == 1u</pre></div>
<div class="requires-constraint"><pre class="requires-constraint-line">sus::construct::SafelyConstructibleFromReference<StorageTypeOfTag<V>, U &&></pre></div>
<div class="requires-constraint"><pre class="requires-constraint-line">std::convertible_to<U &&, StorageTypeOfTag<V>></pre></div>
</div></div>
</div>
<div class="overload">
<div class="function-signature"><div class="src rightside"><a href="https://github.com/chromium/subspace/blob/main/sus/choice/choice.h#L297">source</a></div><a name="method.with"></a><div class="template">template <TagsType V, class... Us></div><span class="static">static</span> <span class="function-auto">auto</span> <a class="function-name" href="sus-choice_type-Choice.html#method.with">with</a>(Us&&... values) -> <a class="type-name" href="sus-choice_type-Choice.html" title="sus::choice_type::Choice">Choice</a><sus::choice_type::__private::TypeList<Ts...>, Tags...><div class="requires">
<span class="requires-keyword keyword">
requires
</span>
<div class="requires-constraint"><pre class="requires-constraint-line">__private::StorageCount<StorageTypeOfTag<V>> > 1u</pre></div>
<div class="requires-constraint"><pre class="requires-constraint-line">sizeof...(Us) ==</pre><pre class="requires-constraint-line"> __private::StorageCount<StorageTypeOfTag<V>></pre></div>
<div class="requires-constraint"><pre class="requires-constraint-line">sus::choice_type::__private::StorageIsSafelyConstructibleFromReference<StorageTypeOfTag<V>, Us &&...></pre></div>
<div class="requires-constraint"><pre class="requires-constraint-line">std::constructible_from<StorageTypeOfTag<V>, Us &&...></pre></div>
</div></div>
</div>
</div>
<div class="description long">
<p>Constructs a <code>Choice</code> with the <code>V</code> tag indicating its active member, and
with the parameters used to set the associated values.</p>
<p>If the associated type of the tag is <code>void</code> then <code>with()</code> takes no
parameters.</p>
</div>
</div>
</div>
<div class="section methods nonstatic">
<h1 class="section-header">
<a name="methods" href="#methods">Methods</a>
</h1>
<div class="section-items">
<div class="overload-set item-name">
<div class="overload">
<div class="function-signature"><div class="src rightside"><a href="https://github.com/chromium/subspace/blob/main/sus/choice/choice.h#L565">source</a></div><a name="method.as"></a><div class="template">template <TagsType V></div><span class="function-auto">auto</span> <a class="function-name" href="sus-choice_type-Choice.html#method.as">as</a>() const& -> decltype(auto)<div class="requires">
<span class="requires-keyword keyword">
requires
</span>
<div class="requires-constraint"><pre class="requires-constraint-line">__private::StorageCount<StorageTypeOfTag<V>> > 0u</pre></div>
</div></div>
</div>
<div class="overload">
<div class="function-signature"><div class="src rightside"><a href="https://github.com/chromium/subspace/blob/main/sus/choice/choice.h#L565">source</a></div><a name="method.as"></a><div class="template">template <TagsType V></div><span class="function-auto">auto</span> <a class="function-name" href="sus-choice_type-Choice.html#method.as">as</a>() && -> <span class="const">const</span> sus::choice_type::Choice::StorageTypeOfTag<V>&<div class="requires">
<span class="requires-keyword keyword">
requires
</span>
<div class="requires-constraint"><pre class="requires-constraint-line">!std::is_reference_v<StorageTypeOfTag<V>></pre></div>
</div><div class="deleted">
deleted
</div></div>
</div>
</div>
<div class="description long">
<p>Returns a const reference to the value(s) inside the <code>Choice</code>.</p>
<p>The function has a template parameter specifying the tag of the active
member in the <code>Choice</code>.</p>
<p>If the active member's associated type is <code>void</code> then this method is
deleted and can't be called.
If the active member has a single value, a reference to it is returned
directly, otherwise a Tuple of references is returned to all values in the
active member.</p>
<h1><a name="panics" href="#panics">Panics</a></h1>
<p>The function will panic if the active member does not match the tag value
passed as the template parameter.</p>
</div>
<div class="overload-set item-name">
<div class="overload">
<div class="function-signature"><div class="src rightside"><a href="https://github.com/chromium/subspace/blob/main/sus/choice/choice.h#L591">source</a></div><a name="method.as_mut"></a><div class="template">template <TagsType V></div><span class="function-auto">auto</span> <a class="function-name" href="sus-choice_type-Choice.html#method.as_mut">as_mut</a>() & -> decltype(auto)<div class="requires">
<span class="requires-keyword keyword">
requires
</span>
<div class="requires-constraint"><pre class="requires-constraint-line">__private::StorageCount<StorageTypeOfTag<V>> > 0u</pre></div>
</div></div>
</div>
</div>
<div class="description long">
<p>Returns a mutable reference to the value(s) inside the <code>Choice</code>.</p>
<p>The function has a template parameter specifying the tag of the active
member in the <code>Choice</code>.</p>
<p>If the active member's associated type is <code>void</code> then this method is
deleted and can't be called.
If the active member has a single value, a reference to it is returned
directly, otherwise a Tuple of references is returned to all values in the
active member.</p>
<h1><a name="panics-1" href="#panics-1">Panics</a></h1>
<p>The function will panic if the active member does not match the tag value
passed as the template parameter.</p>
</div>
<div class="overload-set item-name">
<div class="overload">
<div class="function-signature"><div class="src rightside"><a href="https://github.com/chromium/subspace/blob/main/sus/choice/choice.h#L479">source</a></div><a name="method.clone"></a><span class="function-auto">auto</span> <a class="function-name" href="sus-choice_type-Choice.html#method.clone">clone</a>() const& -> <a class="type-name" href="sus-choice_type-Choice.html" title="sus::choice_type::Choice">Choice</a><sus::choice_type::__private::TypeList<Ts...>, Tags...><div class="requires">
<span class="requires-keyword keyword">
requires
</span>
<div class="requires-constraint"><pre class="requires-constraint-line">(... && ::sus::mem::Clone<Ts>)</pre></div>
<div class="requires-constraint"><pre class="requires-constraint-line">!(... && ::sus::mem::Copy<Ts>)</pre></div>
</div></div>
</div>
</div>
<div class="description long">
<p><a href="sus-mem-Clone.html"><code>Clone</code></a> support.
<code>Choice</code> satisfies <a href="sus-mem-Clone.html"><code>Clone</code></a> when the types it holds all
satisfy <a href="sus-mem-Clone.html"><code>Clone</code></a>.</p>
</div>
<div class="overload-set item-name">
<div class="overload">
<div class="function-signature"><div class="src rightside"><a href="https://github.com/chromium/subspace/blob/main/sus/choice/choice.h#L630">source</a></div><a name="method.get"></a><div class="template">template <TagsType V></div><span class="function-auto">auto</span> <a class="function-name" href="sus-choice_type-Choice.html#method.get">get</a>() const& -> <a class="type-name" href="sus-option-Option.html" title="sus::option::Option">Option</a><sus::choice_type::Choice::AccessTypeOfTagConst<V>><div class="requires">
<span class="requires-keyword keyword">
requires
</span>
<div class="requires-constraint"><pre class="requires-constraint-line">__private::StorageCount<StorageTypeOfTag<V>> > 0u</pre></div>
</div></div>
</div>
<div class="overload">
<div class="function-signature"><div class="src rightside"><a href="https://github.com/chromium/subspace/blob/main/sus/choice/choice.h#L630">source</a></div><a name="method.get"></a><div class="template">template <TagsType V></div><span class="function-auto">auto</span> <a class="function-name" href="sus-choice_type-Choice.html#method.get">get</a>() && -> <a class="type-name" href="sus-option-Option.html" title="sus::option::Option">Option</a><sus::choice_type::Choice::AccessTypeOfTagConst<V>><div class="requires">
<span class="requires-keyword keyword">
requires
</span>
<div class="requires-constraint"><pre class="requires-constraint-line">!std::is_reference_v<StorageTypeOfTag<V>></pre></div>
</div><div class="deleted">
deleted
</div></div>
</div>
</div>
<div class="description long">
<p>Returns a const reference to the value(s) inside the <code>Choice</code>.</p>
<p>If the template parameter does not match the active member in the
<code>Choice</code>, the function returns <code>None</code>.</p>
<p>If the active member's associated type is <code>void</code> then this method is
deleted and can't be called.
If the active member has a single value, a reference to it is returned
directly, otherwise a <a href="sus-tuple_type-Tuple.html"><code>Tuple</code></a> of references is
returned to all values in the active member.</p>
</div>
<div class="overload-set item-name">
<div class="overload">
<div class="function-signature"><div class="src rightside"><a href="https://github.com/chromium/subspace/blob/main/sus/choice/choice.h#L652">source</a></div><a name="method.get_mut"></a><div class="template">template <TagsType V></div><span class="function-auto">auto</span> <a class="function-name" href="sus-choice_type-Choice.html#method.get_mut">get_mut</a>() & -> <a class="type-name" href="sus-option-Option.html" title="sus::option::Option">Option</a><sus::choice_type::Choice::AccessTypeOfTagMut<V>><div class="requires">
<span class="requires-keyword keyword">
requires
</span>
<div class="requires-constraint"><pre class="requires-constraint-line">__private::StorageCount<StorageTypeOfTag<V>> > 0u</pre></div>
</div></div>
</div>
</div>
<div class="description long">
<p>Returns a mutable reference to the value(s) inside the <code>Choice</code>.</p>
<p>If the template parameter does not match the active member in the
<code>Choice</code>, the function returns <code>None</code>.</p>
<p>If the active member's associated type is <code>void</code> then this method is
deleted and can't be called.
If the active member has a single value, a reference to it is returned
directly, otherwise a <a href="sus-tuple_type-Tuple.html"><code>Tuple</code></a> of references is
returned to all values in the active member.</p>
</div>
<div class="overload-set item-name">
<div class="overload">
<div class="function-signature"><div class="src rightside"><a href="https://github.com/chromium/subspace/blob/main/sus/choice/choice.h#L747">source</a></div><a name="method.get_unchecked"></a><div class="template">template <TagsType V></div><span class="function-auto">auto</span> <a class="function-name" href="sus-choice_type-Choice.html#method.get_unchecked">get_unchecked</a>(<a class="type-name" href="sus-marker-UnsafeFnMarker.html" title="sus::marker::UnsafeFnMarker">UnsafeFnMarker</a>) const& -> decltype(auto)<div class="requires">
<span class="requires-keyword keyword">
requires
</span>
<div class="requires-constraint"><pre class="requires-constraint-line">__private::StorageCount<StorageTypeOfTag<V>> > 0u</pre></div>
</div></div>
</div>
<div class="overload">
<div class="function-signature"><div class="src rightside"><a href="https://github.com/chromium/subspace/blob/main/sus/choice/choice.h#L747">source</a></div><a name="method.get_unchecked"></a><div class="template">template <TagsType V></div><span class="function-auto">auto</span> <a class="function-name" href="sus-choice_type-Choice.html#method.get_unchecked">get_unchecked</a>(<a class="type-name" href="sus-marker-UnsafeFnMarker.html" title="sus::marker::UnsafeFnMarker">UnsafeFnMarker</a>) && -> <span class="const">const</span> sus::choice_type::Choice::StorageTypeOfTag<V>&<div class="requires">
<span class="requires-keyword keyword">
requires
</span>
<div class="requires-constraint"><pre class="requires-constraint-line">!std::is_reference_v<StorageTypeOfTag<V>></pre></div>
</div><div class="deleted">
deleted
</div></div>
</div>
</div>
<div class="description long">
<p>Returns a const reference to the value(s) inside the <code>Choice</code>.</p>
<p>The function has a template parameter specifying the tag of the active
member in the <code>Choice</code>.</p>
<p>If the active member's associated type is <code>void</code> then this method is
deleted and can't be called.
If the active member has a single value, a reference to it is returned
directly, otherwise a <a href="sus-tuple_type-Tuple.html"><code>Tuple</code></a> of references is
returned to all values in the active member.</p>
<h1><a name="safety" href="#safety">Safety</a></h1>
<p>If the active member does not match the tag value passed as the template
parameter, Undefined Behaviour results.</p>
</div>
<div class="overload-set item-name">
<div class="overload">
<div class="function-signature"><div class="src rightside"><a href="https://github.com/chromium/subspace/blob/main/sus/choice/choice.h#L774">source</a></div><a name="method.get_unchecked_mut"></a><div class="template">template <TagsType V></div><span class="function-auto">auto</span> <a class="function-name" href="sus-choice_type-Choice.html#method.get_unchecked_mut">get_unchecked_mut</a>(<a class="type-name" href="sus-marker-UnsafeFnMarker.html" title="sus::marker::UnsafeFnMarker">UnsafeFnMarker</a>) & -> decltype(auto)<div class="requires">
<span class="requires-keyword keyword">
requires
</span>
<div class="requires-constraint"><pre class="requires-constraint-line">__private::StorageCount<StorageTypeOfTag<V>> > 0u</pre></div>
</div></div>
</div>
</div>
<div class="description long">
<p>Returns a mutable reference to the value(s) inside the <code>Choice</code>.</p>
<p>The function has a template parameter specifying the tag of the active
member in the <code>Choice</code>.</p>
<p>If the active member's associated type is <code>void</code> then this method is
deleted and can't be called.
If the active member has a single value, a reference to it is returned
directly, otherwise a <a href="sus-tuple_type-Tuple.html"><code>Tuple</code></a> of references is
returned to all values in the active member.</p>
<h1><a name="safety-1" href="#safety-1">Safety</a></h1>
<p>If the active member does not match the tag value passed as the template
parameter, Undefined Behaviour results.</p>
</div>
<div class="overload-set item-name">
<div class="overload">
<div class="function-signature"><div class="src rightside"><a href="https://github.com/chromium/subspace/blob/main/sus/choice/choice.h#L612">source</a></div><a name="method.into_inner"></a><div class="template">template <TagsType V></div><span class="function-auto">auto</span> <a class="function-name" href="sus-choice_type-Choice.html#method.into_inner">into_inner</a>() && -> decltype(auto)<div class="requires">
<span class="requires-keyword keyword">
requires
</span>
<div class="requires-constraint"><pre class="requires-constraint-line">__private::StorageCount<StorageTypeOfTag<V>> > 0u</pre></div>
</div></div>
</div>
</div>
<div class="description long">
<p>Unwraps the <code>Choice</code> to move out the current value(s) inside the <code>Choice</code>.</p>
<p>The function has a template parameter specifying the tag of the active
member in the <code>Choice</code>.</p>
<p>If the active member's associated type is <code>void</code> then this method is
deleted and can't be called.
If the active member has a single value, an rvalue reference to it is
returned directly, otherwise a <a href="sus-tuple_type-Tuple.html"><code>Tuple</code></a> of
rvalue references is returned to all values in the active member.</p>
<h1><a name="panics-2" href="#panics-2">Panics</a></h1>
<p>The function will panic if the active member does not match the tag value
passed as the template parameter.</p>
</div>
<div class="overload-set item-name">
<div class="overload">
<div class="function-signature"><div class="src rightside"><a href="https://github.com/chromium/subspace/blob/main/sus/choice/choice.h#L665">source</a></div><a name="method.set"></a><div class="template">template <TagsType V></div><span class="function-auto">auto</span> <a class="function-name" href="sus-choice_type-Choice.html#method.set">set</a>() & -> void<div class="requires">
<span class="requires-keyword keyword">
requires
</span>
<div class="requires-constraint"><pre class="requires-constraint-line">__private::StorageCount<StorageTypeOfTag<V>> == 0u</pre></div>
</div></div>
</div>
<div class="overload">
<div class="function-signature"><div class="src rightside"><a href="https://github.com/chromium/subspace/blob/main/sus/choice/choice.h#L665">source</a></div><a name="method.set"></a><div class="template">template <TagsType V, class U></div><span class="function-auto">auto</span> <a class="function-name" href="sus-choice_type-Choice.html#method.set">set</a>(U&& value) & -> void<div class="requires">
<span class="requires-keyword keyword">
requires
</span>
<div class="requires-constraint"><pre class="requires-constraint-line">__private::StorageCount<StorageTypeOfTag<V>> == 1u</pre></div>
<div class="requires-constraint"><pre class="requires-constraint-line">sus::construct::SafelyConstructibleFromReference<StorageTypeOfTag<V>, U &&></pre></div>
<div class="requires-constraint"><pre class="requires-constraint-line">std::convertible_to<U &&, StorageTypeOfTag<V>></pre></div>
</div></div>
</div>
<div class="overload">
<div class="function-signature"><div class="src rightside"><a href="https://github.com/chromium/subspace/blob/main/sus/choice/choice.h#L665">source</a></div><a name="method.set"></a><div class="template">template <TagsType V, class... Us></div><span class="function-auto">auto</span> <a class="function-name" href="sus-choice_type-Choice.html#method.set">set</a>(Us&&... values) & -> void<div class="requires">
<span class="requires-keyword keyword">
requires
</span>
<div class="requires-constraint"><pre class="requires-constraint-line">__private::StorageCount<StorageTypeOfTag<V>> > 1u</pre></div>
<div class="requires-constraint"><pre class="requires-constraint-line">sizeof...(Us) ==</pre><pre class="requires-constraint-line"> __private::StorageCount<StorageTypeOfTag<V>></pre></div>
<div class="requires-constraint"><pre class="requires-constraint-line">sus::choice_type::__private::StorageIsSafelyConstructibleFromReference<StorageTypeOfTag<V>, Us &&...></pre></div>
<div class="requires-constraint"><pre class="requires-constraint-line">std::constructible_from<StorageTypeOfTag<V>, Us &&...></pre></div>
</div></div>
</div>
</div>
<div class="description long">
<p>Changes the <code>Choice</code> to make the tag <code>V</code> active, and sets the associated
values of <code>V</code> from the paramters.</p>
<p>If the associated type of the tag is <code>void</code> then <code>set()</code> takes no
parameters.</p>
</div>
<div class="overload-set item-name">
<div class="overload">
<div class="function-signature"><div class="src rightside"><a href="https://github.com/chromium/subspace/blob/main/sus/choice/choice.h#L543">source</a></div><a name="method.which"></a><span class="function-auto">auto</span> <a class="function-name" href="sus-choice_type-Choice.html#method.which">which</a>() const& -> sus::choice_type::Choice::TagsType</div>
</div>
</div>
<div class="description long">
<p>Returns which is the active member of the <code>Choice</code>.</p>
<p>Typically to access the data in the <code>Choice</code>, a <code>switch</code> statement would
be used, so as to call the getter or setter methods with the right value
specified as a template parameter. When used in a <code>switch</code> statement, the
<code>which</code> method can be omitted.</p>
<h1><a name="example" href="#example">Example</a></h1>
<pre><code><span class="keyword">switch</span> <span class="punct">(</span>my_choice<span class="punct">)</span> <span class="punct">{</span>
<span class="keyword">case</span> Value1: <span class="keyword">return</span> my_choice<span class="punct">.</span>as<span class="punct"><</span>Value1<span class="punct">></span><span class="punct">(</span><span class="punct">)</span><span class="punct">.</span>stuff<span class="punct">;</span>
<span class="keyword">case</span> Value2: <span class="keyword">return</span> my_choice<span class="punct">.</span>as<span class="punct"><</span>Value2<span class="punct">></span><span class="punct">(</span><span class="punct">)</span><span class="punct">.</span>andmore<span class="punct">;</span>
<span class="keyword">case</span> Value3: <span class="keyword">return</span> my_choice<span class="punct">.</span>as<span class="punct"><</span>Value3<span class="punct">></span><span class="punct">(</span><span class="punct">)</span><span class="punct">.</span>stufftoo<span class="punct">;</span>
<span class="punct">}</span>
</code></pre>
<h1><a name="inspiration" href="#inspiration">Inspiration</a></h1>
<pre><code class="language-txt">
████████
████▓▓░░▓▓██
██▓▓▓▓▓▓▓▓██
██▓▓▓▓░░▓▓██
██░░▓▓▓▓▓▓██
██▓▓▓▓▓▓▓▓▓▓██
██▓▓▓▓░░▓▓▓▓██
████████▓▓▓▓▓▓▓▓▓▓▓▓▓▓████████
██▓▓░░▓▓▓▓▓▓░░▓▓▓▓▓▓▓▓▓▓░░▓▓▓▓▓▓██
██████████████████▓▓██████████████
██ ██ ██
██ ██ ██ ██
██ ██ ████ ██
██ ██ ██
██▒▒ ██ ██
██▒▒ ██ ██
████████████████████
██ ██
██ ██▓▓██
▓▓ ██▓▓▓▓██
██ ████░░▓▓▓▓██ ▓▓▓▓▓▓▓▓▓▓▓▓
██ ██ ██▓▓▓▓░░▓▓██ ▓▓░░░░░░░░░░░░
██ ██ ████▓▓▓▓▓▓██ ▓▓▓▓▓▓▓▓▓▓▓▓▓▓
▓▓▓▓ ██ ██ ██▓▓▓▓▓▓░░▓▓██ ▓▓▓▓░░░░░░░░░░░░
▓▓▓▓▓▓▓▓▓▓██████▓▓▓▓██▓▓░░▓▓▓▓██▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓
██████████ ▓▓▓▓░░░░░░░░░░░░
██ ██ ▓▓▓▓▓▓▓▓▓▓▓▓▓▓
██ ██ ▓▓░░░░░░░░░░░░
██ ██ ▓▓▓▓▓▓▓▓▓▓▒▒
████
</code></pre>
</div>
</div>
</div>
<div class="section methods conversion">
<h1 class="section-header">
<a name="conversions" href="#conversions">Conversions</a>
</h1>
<div class="section-items">
<div class="overload-set item-name">
<div class="overload">
<div class="function-signature"><div class="src rightside"><a href="https://github.com/chromium/subspace/blob/main/sus/choice/choice.h#L491">source</a></div><a name="method.operator TagsType"></a><a class="function-name" href="sus-choice_type-Choice.html#method.operator TagsType">operator TagsType</a>() const&</div>
</div>
</div>
<div class="description long">
<p>Support for using Choice in a <code>switch()</code> statment.</p>
<p>See the type's top level documentation for an example.</p>
</div>
</div>
</div>
<div class="section methods nonstatic">
<h1 class="section-header">
<a name="operators" href="#operators">Operators</a>
</h1>
<div class="section-items">
<div class="overload-set item-name">
<div class="overload">
<div class="function-signature"><div class="src rightside"><a href="https://github.com/chromium/subspace/blob/main/sus/choice/choice.h#L394">source</a></div><a name="method.operator=.move"></a><span class="function-auto">auto</span> <a class="function-name" href="sus-choice_type-Choice.html#method.operator=.move">operator=</a>(<a class="type-name" href="sus-choice_type-Choice.html" title="sus::choice_type::Choice">Choice</a><sus::choice_type::__private::TypeList<Ts...>, Tags...>&& o) -> <a class="type-name" href="sus-choice_type-Choice.html" title="sus::choice_type::Choice">Choice</a><sus::choice_type::__private::TypeList<Ts...>, Tags...>&<div class="requires">
<span class="requires-keyword keyword">
requires
</span>
<div class="requires-constraint"><pre class="requires-constraint-line">(... && ::sus::mem::Move<Ts>)</pre></div>
<div class="requires-constraint"><pre class="requires-constraint-line">(std::is_trivially_move_assignable_v<TagsType> && ... &&</pre><pre class="requires-constraint-line"> std::is_trivially_move_assignable_v<Ts>)</pre></div>
</div></div>
</div>
<div class="overload">
<div class="function-signature"><div class="src rightside"><a href="https://github.com/chromium/subspace/blob/main/sus/choice/choice.h#L394">source</a></div><a name="method.operator=.move"></a><span class="function-auto">auto</span> <a class="function-name" href="sus-choice_type-Choice.html#method.operator=.move">operator=</a>(<a class="type-name" href="sus-choice_type-Choice.html" title="sus::choice_type::Choice">Choice</a><sus::choice_type::__private::TypeList<Ts...>, Tags...>&& o) -> <a class="type-name" href="sus-choice_type-Choice.html" title="sus::choice_type::Choice">Choice</a><sus::choice_type::__private::TypeList<Ts...>, Tags...>&<div class="requires">
<span class="requires-keyword keyword">
requires
</span>
<div class="requires-constraint"><pre class="requires-constraint-line">(... && ::sus::mem::Move<Ts>)</pre></div>
<div class="requires-constraint"><pre class="requires-constraint-line">!(std::is_trivially_move_assignable_v<TagsType> && ... &&</pre><pre class="requires-constraint-line"> std::is_trivially_move_assignable_v<Ts>)</pre></div>
</div></div>
</div>
<div class="overload">
<div class="function-signature"><div class="src rightside"><a href="https://github.com/chromium/subspace/blob/main/sus/choice/choice.h#L394">source</a></div><a name="method.operator=.move"></a><span class="function-auto">auto</span> <a class="function-name" href="sus-choice_type-Choice.html#method.operator=.move">operator=</a>(<a class="type-name" href="sus-choice_type-Choice.html" title="sus::choice_type::Choice">Choice</a><sus::choice_type::__private::TypeList<Ts...>, Tags...>&& o) -> <a class="type-name" href="sus-choice_type-Choice.html" title="sus::choice_type::Choice">Choice</a><sus::choice_type::__private::TypeList<Ts...>, Tags...>&<div class="requires">
<span class="requires-keyword keyword">
requires
</span>
<div class="requires-constraint"><pre class="requires-constraint-line">!(... && ::sus::mem::Move<Ts>)</pre></div>
</div><div class="deleted">
deleted
</div></div>
</div>
</div>
<div class="description long">
<p>Move assignment.</p>
<p><code>Choice</code> satisfies <a href="sus-mem-Move.html"><code>Move</code></a> when the types it holds all
satisfy <a href="sus-mem-Move.html"><code>Move</code></a>.</p>
</div>
<div class="overload-set item-name">
<div class="overload">
<div class="function-signature"><div class="src rightside"><a href="https://github.com/chromium/subspace/blob/main/sus/choice/choice.h#L450">source</a></div><a name="method.operator=.copy"></a><span class="function-auto">auto</span> <a class="function-name" href="sus-choice_type-Choice.html#method.operator=.copy">operator=</a>(<span class="const">const</span> <a class="type-name" href="sus-choice_type-Choice.html" title="sus::choice_type::Choice">Choice</a><sus::choice_type::__private::TypeList<Ts...>, Tags...>& o) -> <a class="type-name" href="sus-choice_type-Choice.html" title="sus::choice_type::Choice">Choice</a><sus::choice_type::__private::TypeList<Ts...>, Tags...>&<div class="requires">
<span class="requires-keyword keyword">
requires
</span>
<div class="requires-constraint"><pre class="requires-constraint-line">(... && ::sus::mem::Copy<Ts>)</pre></div>
<div class="requires-constraint"><pre class="requires-constraint-line">(std::is_trivially_copy_assignable_v<TagsType> && ... &&</pre><pre class="requires-constraint-line"> std::is_trivially_copy_assignable_v<Ts>)</pre></div>
</div></div>
</div>
<div class="overload">
<div class="function-signature"><div class="src rightside"><a href="https://github.com/chromium/subspace/blob/main/sus/choice/choice.h#L450">source</a></div><a name="method.operator=.copy"></a><span class="function-auto">auto</span> <a class="function-name" href="sus-choice_type-Choice.html#method.operator=.copy">operator=</a>(<span class="const">const</span> <a class="type-name" href="sus-choice_type-Choice.html" title="sus::choice_type::Choice">Choice</a><sus::choice_type::__private::TypeList<Ts...>, Tags...>& o) -> <a class="type-name" href="sus-choice_type-Choice.html" title="sus::choice_type::Choice">Choice</a><sus::choice_type::__private::TypeList<Ts...>, Tags...>&<div class="requires">
<span class="requires-keyword keyword">
requires
</span>
<div class="requires-constraint"><pre class="requires-constraint-line">(... && ::sus::mem::Copy<Ts>)</pre></div>
<div class="requires-constraint"><pre class="requires-constraint-line">!(std::is_trivially_copy_assignable_v<TagsType> && ... &&</pre><pre class="requires-constraint-line"> std::is_trivially_copy_assignable_v<Ts>)</pre></div>
</div></div>
</div>
<div class="overload">
<div class="function-signature"><div class="src rightside"><a href="https://github.com/chromium/subspace/blob/main/sus/choice/choice.h#L450">source</a></div><a name="method.operator=.copy"></a><span class="function-auto">auto</span> <a class="function-name" href="sus-choice_type-Choice.html#method.operator=.copy">operator=</a>(<span class="const">const</span> <a class="type-name" href="sus-choice_type-Choice.html" title="sus::choice_type::Choice">Choice</a><sus::choice_type::__private::TypeList<Ts...>, Tags...>& o) -> <a class="type-name" href="sus-choice_type-Choice.html" title="sus::choice_type::Choice">Choice</a><sus::choice_type::__private::TypeList<Ts...>, Tags...>&<div class="requires">
<span class="requires-keyword keyword">
requires
</span>
<div class="requires-constraint"><pre class="requires-constraint-line">!(... && ::sus::mem::Copy<Ts>)</pre></div>
</div><div class="deleted">
deleted
</div></div>
</div>
</div>
<div class="description long">
<p>Copy assignment.</p>
<p><code>Choice</code> satisfies <a href="sus-mem-Copy.html"><code>Copy</code></a> when the types it holds all
satisfy <a href="sus-mem-Copy.html"><code>Copy</code></a>.</p>
</div>
</div>
</div>
</div>
</section>