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
use PhantomData;
use ;
use ;
use ;
use Mut;
use ;
;
;
;
;
;
/// Clones a type when it is retrieved
///
/// ## Example
/// ```
/// # use bevy_query_ext::prelude::*;
/// # use bevy::prelude::*;
/// #[derive(Clone, Component)]
/// struct CloneMe;
///
/// fn example(query: Query<Cloned<CloneMe>>) {
/// let _: CloneMe = query.single().unwrap();
/// }
/// ```
///
/// ## Counter Example: Type must be clone
/// ```compile_fail
/// # use bevy_query_ext::prelude::*;
/// # use bevy::prelude::*;
/// #[derive(Component)]
/// struct NotClone;
///
/// fn example(query: Query<Cloned<NotClone>>) {
/// let _: NotClone = query.single().unwrap();
/// }
/// ```
///
/// ## Counter Example: Why would you want this
/// ```compile_fail
/// # use bevy_query_ext::prelude::*;
/// # use bevy::prelude::*;
/// #[derive(Clone,Component)]
/// struct CloneMe;
///
/// fn example(query: Query<Cloned<Cloned<CloneMe>>>) {
/// let _: CloneMe = query.single().unwrap();
/// }
/// ```
pub type Cloned<T> = ;
/// Copies a type when it is retrieved
/// ## Example
/// ```
/// # use bevy_query_ext::prelude::*;
/// # use bevy::prelude::*;
/// #[derive(Clone, Copy, Component)]
/// struct CopyMe;
///
/// fn example(query: Query<Copied<CopyMe>>) {
/// let _: CopyMe = query.single().unwrap();
/// }
/// ```
///
/// ## Counter Example: Type must be clone
/// ```compile_fail
/// # use bevy_query_ext::prelude::*;
/// # use bevy::prelude::*;
/// #[derive(Component)]
/// struct NotCopy;
///
/// fn bad_example(query: Query<Copied<NotCopy>>) {
/// let _: NotCopy = query.single().unwrap();
/// }
/// ```
///
/// ## Counter Example: Why would you want this
/// ```compile_fail
/// # use bevy_query_ext::prelude::*;
/// # use bevy::prelude::*;
/// #[derive(Clone, Copy, Component)]
/// struct CopyMe;
///
/// fn bad_example(query: Query<Copied<Copied<CopyMe>>>) {
/// let _: CopyMe = query.single().unwrap();
/// }
/// ```
pub type Copied<T> = ;
/// Returns the dereferenced component
/// ## Example
/// ```
/// # use bevy_query_ext::prelude::*;
/// # use bevy::prelude::*;
/// #[derive(Component, Deref)]
/// struct WrappedBool(bool);
///
/// fn example(query: Query<AsDeref<WrappedBool>>) {
/// let _: &bool = query.single().unwrap();
/// }
/// ```
/// ## Counter Example: Type must be Deref
/// ```compile_fail
/// # use bevy_query_ext::prelude::*;
/// # use bevy::prelude::*;
/// #[derive(Component)]
/// struct WrappedBool(bool);
///
/// fn bad_example(query: Query<AsDeref<WrappedBool>>) {
/// let _: &bool = query.single().unwrap();
/// }
/// ```
/// ## Counter Example: Nested Derefs are not currently supported
/// ```compile_fail
/// # use bevy_query_ext::prelude::*;
/// # use bevy::prelude::*;
///
/// #[derive(Component,Deref)]
/// struct WrappedBool(bool);
///
/// #[derive(Component,Deref)]
/// struct Wwb(WrappedBool);
///
/// fn bad_example(query: Query<AsDeref<AsDeref<WrappedBool>>>) {
/// let _: &bool = query.single().unwrap();
/// }
/// ```
pub type AsDeref<T> = ;
/// Returns the dereferenced component as a [`Mut`](bevy::ecs::world::Mut), or a reference if it is
/// readonly.
///
/// ## Example
/// ```
/// # use bevy_query_ext::prelude::*;
/// # use bevy::prelude::*;
/// #[derive(Component, Deref, DerefMut)]
/// struct WrappedBool(bool);
///
/// fn example(mut query: Query<AsDerefMut<WrappedBool>>) {
/// let _: Mut<bool> = query.single_mut().unwrap();
/// let _: &bool = query.single().unwrap();
/// }
/// ```
/// ## Counter Example: Type must be DerefMut
/// ```compile_fail
/// # use bevy_query_ext::prelude::*;
/// # use bevy::prelude::*;
/// #[derive(Component, Deref)]
/// struct WrappedBool(bool);
///
/// fn bad_example(mut query: Query<AsDerefMut<WrappedBool>>) {
/// let _: Mut<bool> = query.single_mut().unwrap();
/// let _: &bool = query.single().unwrap();
/// }
/// ```
/// ## Counter Example: DerefMut does not really compose well with others (Why would it?)
/// ```compile_fail
/// # use bevy_query_ext::prelude::*;
/// # use bevy::prelude::*;
/// #[derive(Component, Deref, DerefMut)]
/// struct WrappedBool(bool);
///
/// fn bad_example(query: Query<Copied<AsDerefMut<WrappedBool>>>) {
/// let _: bool = query.single().unwrap();
/// }
///
/// ```
pub type AsDerefMut<T> = ;
/// Returns a copy of the dereferenced value (alias of `Copied<AsDeref<T>`)
/// ## Example
/// ```
/// # use bevy_query_ext::prelude::*;
/// # use bevy::prelude::*;
/// #[derive(Component, Deref)]
/// struct WrappedBool(bool);
///
/// fn example(query: Query<AsDerefCopied<WrappedBool>>) {
/// let _: bool = query.single().unwrap();
/// }
/// ```
/// ## Counter example: Outer type must implement Deref
/// ```compile_fail
/// # use bevy_query_ext::prelude::*;
/// # use bevy::prelude::*;
/// #[derive(Component, Copy)]
/// struct WrappedBool(bool);
///
/// fn example(query: Query<AsDerefCopied<WrappedBool>>) {
/// let _: bool = query.single().unwrap();
/// }
/// ```
/// ## Counter example: Inner type must implement Copy
///
/// But noteably, the outer type does NOT need to implement Copy
///
/// ```compile_fail
/// # use bevy_query_ext::prelude::*;
/// # use bevy::prelude::*;
/// #[derive(Component, Deref)]
/// struct WrappedBool(Vec<bool>);
///
/// fn example(query: Query<AsDerefCopied<WrappedBool>>) {
/// let _: Vec<bool> = query.single().unwrap();
/// }
/// ```
pub type AsDerefCopied<T> = ;
/// Returns a clone of the dereferenced value (alias of `Cloned<AsDeref<T>>`)
/// ## Example
/// ```
/// # use bevy_query_ext::prelude::*;
/// # use bevy::prelude::*;
/// #[derive(Component, Deref)]
/// struct WrappedBool(Vec<bool>);
///
/// fn example(query: Query<AsDerefCloned<WrappedBool>>) {
/// let _: Vec<bool> = query.single().unwrap();
/// }
/// ```
/// ## Counter example: Outer type must implement Deref
/// ```compile_fail
/// # use bevy_query_ext::prelude::*;
/// # use bevy::prelude::*;
/// #[derive(Component, Clone)]
/// struct WrappedBool(Vec<bool>);
///
/// fn example(query: Query<AsDerefCloned<WrappedBool>>) {
/// let _: Vec<bool> = query.single().unwrap();
/// }
/// ```
/// ## Counter example: Inner type must implement Clone
///
/// But notably, the outer type does NOT need to implement Clone
/// ```compile_fail
/// # use bevy_query_ext::prelude::*;
/// # use bevy::prelude::*;
///
/// struct Uncloneable;
///
/// #[derive(Component, Deref)]
/// struct WrappedBool(Uncloneable);
///
/// fn example(query: Query<AsDerefCloned<WrappedBool>>) {
/// let _: Uncloneable = query.single().unwrap();
/// }
/// ```
pub type AsDerefCloned<T> = ;
/// First either clones component T or gets the default value, then dereferences this value and
/// copies it.
///
/// This is primarily useful over [`AsDerefCopiedOrDefault`] when default for the component is
/// different than the default for the dereferenced type.
///
/// ## Example
/// ```
/// # use bevy_query_ext::prelude::*;
/// # use bevy::prelude::*;
/// #[derive(Component, Deref, Clone)]
/// struct Temperature(f32);
///
/// // Notably the default for Temperature is different than the default for the
/// // dereferenced value. Using this type, if the component is not present on
/// // the entity, the query will return 20.0, rather than 0.0.
/// impl Default for Temperature {
/// fn default() -> Self {
/// Self(20.0)
/// }
/// }
///
/// fn example(query: Query<AsDerefCopiedOfClonedOrDefault<Temperature>>) {
/// let _: f32 = query.single().unwrap();
/// }
/// ```
/// ## Counter example: Outer type must implement Default, Deref AND Clone
/// ```compile_fail
/// # use bevy_query_ext::prelude::*;
/// # use bevy::prelude::*;
/// #[derive(Component, Deref)]
/// struct Temperature(f32);
///
/// impl Default for Temperature {
/// fn default() -> Self {
/// Self(20.0)
/// }
/// }
///
/// fn bad_example(query: Query<AsDerefCopiedOfClonedOrDefault<Temperature>>) {
/// let _: f32 = query.single().unwrap();
/// }
/// ```
/// ## Counter example: Dereferenced type must implement Copy
///
/// ```compile_fail
/// # use bevy_query_ext::prelude::*;
/// # use bevy::prelude::*;
/// #[derive(Component, Deref)]
/// struct Temperatures(Vec<f32>);
///
/// impl Default for Temperatures {
/// fn default() -> Self {
/// Self(vec![20.0])
/// }
/// }
///
/// fn bad_example(query: Query<AsDerefCopiedOfClonedOrDefault<Temperatures>>) {
/// let _: Vec<f32> = query.single().unwrap();
/// }
///
/// ```
pub type AsDerefCopiedOfClonedOrDefault<T> = ;
/// First either copies component T or gets the default value, then dereferences this value and
/// copies it.
///
/// This is primarily useful over [`AsDerefCopiedOrDefault`] when default for the component is
/// different than the default for the dereferenced type.
///
/// ## Example
/// ```
/// # use bevy_query_ext::prelude::*;
/// # use bevy::prelude::*;
/// #[derive(Component, Deref, Clone, Copy)]
/// struct Temperature(f32);
///
/// // Notably the default for Temperature is different than the default for the
/// // dereferenced value. Using this type, if the component is not present on
/// // the entity, the query will return 20.0, rather than 0.0.
/// impl Default for Temperature {
/// fn default() -> Self {
/// Self(20.0)
/// }
/// }
///
/// fn example(query: Query<AsDerefCopiedOfCopiedOrDefault<Temperature>>) {
/// let _: f32 = query.single().unwrap();
/// }
/// ```
/// ## Counter example: Outer type must implement Default, Deref AND Copy
/// ```compile_fail
/// # use bevy_query_ext::prelude::*;
/// # use bevy::prelude::*;
/// #[derive(Component, Deref, Clone)]
/// struct NoCopyTemperature(f32);
///
/// impl Default for NoCopyTemperature {
/// fn default() -> Self {
/// Self(20.0)
/// }
/// }
///
/// fn bad_example(query: Query<AsDerefCopiedOfCopiedOrDefault<NoCopyTemperature>>) {
/// let _: f32 = query.single().unwrap();
/// }
/// ```
/// ## Counter example: Dereferenced type must implement Copy
///
/// ```compile_fail
/// # use bevy_query_ext::prelude::*;
/// # use bevy::prelude::*;
/// #[derive(Component, Deref)]
/// struct Temperatures(Vec<f32>);
///
/// impl Default for Temperatures {
/// fn default() -> Self {
/// Self(vec![20.0])
/// }
/// }
///
/// fn bad_example(query: Query<AsDerefCopiedOfCopiedOrDefault<Temperatures>>) {
/// let _: Vec<f32> = query.single().unwrap();
/// }
/// ```
pub type AsDerefCopiedOfCopiedOrDefault<T> = ;
/// First either clones component T or gets the default value, then dereferences this value and
/// clones it.
///
/// This is primarily useful over [`AsDerefClonedOrDefault`] when default for the component is
/// different than the default for the dereferenced type.
///
/// ## Example
/// ```
/// # use bevy_query_ext::prelude::*;
/// # use bevy::prelude::*;
/// #[derive(Component, Deref, Clone)]
/// struct Temperatures(Vec<f32>);
///
/// // Notably the default for Temperature is different than the default for the
/// // dereferenced value. Using this type, if the component is not present on
/// // the entity, the query will return 20.0, rather than 0.0.
/// impl Default for Temperatures {
/// fn default() -> Self {
/// Self(vec![20.0])
/// }
/// }
///
/// fn example(query: Query<AsDerefClonedOfClonedOrDefault<Temperatures>>) {
/// let _: Vec<f32> = query.single().unwrap();
/// }
/// ```
/// ## Counter example: Outer type must implement Default, Deref AND Clone
/// ```compile_fail
/// # use bevy_query_ext::prelude::*;
/// # use bevy::prelude::*;
/// #[derive(Component, Deref)]
/// struct Temperatures(Vec<f32>);
///
/// impl Default for Temperatures {
/// fn default() -> Self {
/// Self(vec![20.0])
/// }
/// }
///
/// fn bad_example(query: Query<AsDerefClonedOfClonedOrDefault<Temperatures>>) {
/// let _: Vec<f32> = query.single().unwrap();
/// }
/// ```
/// ## Counter example: Dereferenced type must implement Clone
///
/// ```compile_fail
/// # use bevy_query_ext::prelude::*;
/// # use bevy::prelude::*;
///
/// struct Uncloneable;
///
/// #[derive(Component, Deref, Clone)]
/// struct Temperature(Uncloneable);
///
/// impl Default for Temperature {
/// fn default() -> Self {
/// Self(Uncloneable)
/// }
/// }
///
/// fn bad_example(query: Query<AsDerefClonedOfClonedOrDefault<Temperature>>) {
/// let _: Uncloneable = query.single().unwrap();
/// }
///
/// ```
pub type AsDerefClonedOfClonedOrDefault<T> = ;
// ModQuery: OrX, works on any readonly query
/// If the query exists on the entity it is returned, or else the default for the query result
/// ## Example
/// ```
/// # use bevy_query_ext::prelude::*;
/// # use bevy::prelude::*;
/// #[derive(Component, Clone, Copy, Default)]
/// struct Velocity2D{x: f32, y: f32};
///
/// // Note: This query is also aliased as `CopiedOrDefault`
/// fn example(query: Query<OrDefault<Copied<Velocity2D>>>) {
/// // If item does not have Velocity2D, a default is created
/// let _: Velocity2D = query.single().unwrap();
/// }
/// ```
/// ## Counter example: Can't use on component directly
/// ```compile_fail
/// # use bevy_query_ext::prelude::*;
/// # use bevy::prelude::*;
/// #[derive(Component, Clone, Copy, Default)]
/// struct Velocity2D{x: f32, y: f32};
///
/// fn bad_example(query: Query<OrDefault<Velocity2D>>) {
/// let _: Velocity2D = query.single().unwrap();
/// }
/// ```
/// ## Example: Default for references
/// Normally default is not implemented for &T, even if T: Default. The following will not work
/// ```compile_fail
/// # use bevy_query_ext::prelude::*;
/// # use bevy::prelude::*;
/// #[derive(Component, Copy, Clone, Default)]
/// struct Velocity2D{x: f32, y: f32};
///
/// fn example(query: Query<OrDefault<&Velocity2D>>) {
/// let _: &Velocity2D = query.single().unwrap();
/// }
/// ```
///
/// But you can implement it manually if you don't want to copy/clone components but still have a
/// default. You'll have to try something like this though:
/// ```
/// # use bevy_query_ext::prelude::*;
/// # use bevy::prelude::*;
/// #[derive(Component)]
/// struct Velocity2D{x: f32, y: f32};
///
/// const DEFAULT_VEL: Velocity2D = Velocity2D {x: 0.0, y: 0.0};
///
/// impl Default for &Velocity2D {
/// fn default() -> Self {
/// &DEFAULT_VEL
/// }
/// }
///
/// fn example(query: Query<OrDefault<&Velocity2D>>) {
/// let _: &Velocity2D = query.single().unwrap();
/// }
/// ```
pub type OrDefault<T> = ;
/// Returns a copy of component or default. See [`Copied`] and [`OrDefault`]
/// ```
/// # use bevy_query_ext::prelude::*;
/// # use bevy::prelude::*;
/// #[derive(Component, Clone, Copy, Default)]
/// struct Velocity2D{x: f32, y: f32};
///
/// fn example(query: Query<CopiedOrDefault<Velocity2D>>) {
/// // If item does not have Velocity2D, a default is created
/// let _: Velocity2D = query.single().unwrap();
/// }
/// ```
pub type CopiedOrDefault<T> = ;
/// Returns a clone of component or default. See [`Cloned`] and [`OrDefault`]
/// ```
/// # use bevy_query_ext::prelude::*;
/// # use bevy::prelude::*;
/// #[derive(Component, Clone, Default)]
/// struct Velocity2D{x: f32, y: f32};
///
/// fn example(query: Query<ClonedOrDefault<Velocity2D>>) {
/// // If item does not have Velocity2D, a default is created
/// let _: Velocity2D = query.single().unwrap();
/// }
/// ```
pub type ClonedOrDefault<T> = ;
/// Returns a copy of component's dereferenced value, or default for that type. See [`Copied`], [`AsDeref`] and [`OrDefault`]
///
/// If you want a copied value of the component's default value instead of the default value of the
/// dereferenced type, see [`AsDerefCopiedOfCopiedOrDefault`] or [`AsDerefCopiedOfClonedOrDefault`]
/// ```
/// # use bevy_query_ext::prelude::*;
/// # use bevy::prelude::*;
/// #[derive(Component, Deref)]
/// struct IsFrozen(bool);
///
/// fn example(query: Query<AsDerefCopiedOrDefault<IsFrozen>>) {
/// // If IsFrozen is not present, will default to `false`
/// let _: bool = query.single().unwrap();
/// }
/// ```
pub type AsDerefCopiedOrDefault<T> = ;
/// Returns a clone of component's dereferenced value, or default for that type. See [`Cloned`], [`AsDeref`] and [`OrDefault`]
///
/// If you want a cloned value of the component's default value instead of the default value of the
/// dereferenced type, see [`AsDerefClonedOfClonedOrDefault`]
/// ```
/// # use bevy_query_ext::prelude::*;
/// # use bevy::prelude::*;
/// #[derive(Component, Deref)]
/// struct FriendNames(Vec<String>);
///
/// fn example(query: Query<AsDerefClonedOrDefault<FriendNames>>) {
/// let _: Vec<String> = query.single().unwrap();
/// }
/// ```
pub type AsDerefClonedOrDefault<T> = ;