/
Light.GuardClauses.SingleFile.cs
6357 lines (6020 loc) · 408 KB
/
Light.GuardClauses.SingleFile.cs
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
/* ------------------------------
Light.GuardClauses 10.3.0
------------------------------
License information for Light.GuardClauses
The MIT License (MIT)
Copyright (c) 2016, 2023 Kenny Pflug mailto:kenny.pflug@live.de
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and / or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
*/
using System;
using System.Collections;
using System.Collections.Generic;
using System.Collections.ObjectModel;
using System.Diagnostics.CodeAnalysis;
using System.Linq;
using System.Linq.Expressions;
using System.Reflection;
using System.Runtime.CompilerServices;
using System.Runtime.Serialization;
using System.Text;
using System.Text.RegularExpressions;
using JetBrains.Annotations;
using Light.GuardClauses.Exceptions;
using Light.GuardClauses.FrameworkExtensions;
#nullable enable annotations
namespace Light.GuardClauses
{
/// <summary>
/// The <see cref = "Check"/> class provides access to all assertions of Light.GuardClauses.
/// </summary>
internal static class Check
{
/// <summary>
/// Ensures that the specified object reference is not null, or otherwise throws an <see cref = "ArgumentNullException"/>.
/// </summary>
/// <param name = "parameter">The object reference to be checked.</param>
/// <param name = "parameterName">The name of the parameter (optional).</param>
/// <param name = "message">The message that will be passed to the resulting exception (optional).</param>
/// <exception cref = "ArgumentNullException">Thrown when <paramref name = "parameter"/> is null.</exception>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
[ContractAnnotation("parameter:null => halt; parameter:notnull => notnull")]
public static T MustNotBeNull<T>([ValidatedNotNull, NoEnumeration] this T? parameter, [CallerArgumentExpression("parameter")] string? parameterName = null, string? message = null)
where T : class
{
if (parameter is null)
Throw.ArgumentNull(parameterName, message);
return parameter;
}
/// <summary>
/// Ensures that the specified object reference is not null, or otherwise throws your custom exception.
/// </summary>
/// <param name = "parameter">The reference to be checked.</param>
/// <param name = "exceptionFactory">The delegate that creates your custom exception.</param>
/// <exception cref = "Exception">Your custom exception thrown when <paramref name = "parameter"/> is null.</exception>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
[ContractAnnotation("parameter:null => halt; parameter:notnull => notnull; exceptionFactory:null => halt")]
public static T MustNotBeNull<T>([ValidatedNotNull, NoEnumeration] this T? parameter, Func<Exception> exceptionFactory)
where T : class
{
if (parameter is null)
Throw.CustomException(exceptionFactory);
return parameter;
}
/// <summary>
/// Ensures that the specified parameter is not the default value, or otherwise throws an <see cref = "ArgumentNullException"/>
/// for reference types, or an <see cref = "ArgumentDefaultException"/> for value types.
/// </summary>
/// <param name = "parameter">The value to be checked.</param>
/// <param name = "parameterName">The name of the parameter (optional).</param>
/// <param name = "message">The message that will be passed to the resulting exception (optional).</param>
/// <exception cref = "ArgumentNullException">Thrown when <paramref name = "parameter"/> is a reference type and null.</exception>
/// <exception cref = "ArgumentDefaultException">Thrown when <paramref name = "parameter"/> is a value type and the default value.</exception>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
[ContractAnnotation("parameter:null => halt; parameter:notnull => notnull")]
public static T MustNotBeDefault<T>([ValidatedNotNull] this T parameter, [CallerArgumentExpression("parameter")] string? parameterName = null, string? message = null)
{
if (default(T)is null)
{
if (parameter is null)
Throw.ArgumentNull(parameterName, message);
return parameter;
}
if (EqualityComparer<T>.Default.Equals(parameter, default !))
Throw.ArgumentDefault(parameterName, message);
return parameter;
}
/// <summary>
/// Ensures that the specified parameter is not the default value, or otherwise throws your custom exception.
/// </summary>
/// <param name = "parameter">The value to be checked.</param>
/// <param name = "exceptionFactory">The delegate that creates your custom exception.</param>
/// <exception cref = "Exception">Your custom exception thrown when <paramref name = "parameter"/> is the default value.</exception>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
[ContractAnnotation("parameter:null => halt; parameter:notnull => notnull; exceptionFactory:null => halt")]
public static T MustNotBeDefault<T>([ValidatedNotNull] this T parameter, Func<Exception> exceptionFactory)
{
if (default(T)is null)
{
if (parameter is null)
Throw.CustomException(exceptionFactory);
return parameter;
}
if (EqualityComparer<T>.Default.Equals(parameter, default !))
Throw.CustomException(exceptionFactory);
return parameter;
}
/// <summary>
/// Ensures that the specified parameter is not null when <typeparamref name = "T"/> is a reference type, or otherwise
/// throws an <see cref = "ArgumentNullException"/>. PLEASE NOTICE: you should only use this assertion in generic contexts,
/// use <see cref = "MustNotBeNull{T}(T, string, string)"/> by default.
/// </summary>
/// <param name = "parameter">The value to be checked for null.</param>
/// <param name = "parameterName">The name of the parameter (optional).</param>
/// <param name = "message">The message that will be passed to the resulting exception (optional).</param>
/// <exception cref = "ArgumentNullException">Thrown when <typeparamref name = "T"/> is a reference type and <paramref name = "parameter"/> is null.</exception>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
[ContractAnnotation("parameter:null => halt; parameter:notnull => notnull")]
public static T MustNotBeNullReference<T>([ValidatedNotNull, NoEnumeration] this T parameter, [CallerArgumentExpression("parameter")] string? parameterName = null, string? message = null)
{
if (default(T) != null)
return parameter;
if (parameter is null)
Throw.ArgumentNull(parameterName, message);
return parameter;
}
/// <summary>
/// Ensures that the specified parameter is not null when <typeparamref name = "T"/> is a reference type, or otherwise
/// throws your custom exception. PLEASE NOTICE: you should only use this assertion in generic contexts,
/// use <see cref = "MustNotBeNull{T}(T, Func{Exception})"/> by default.
/// </summary>
/// <param name = "parameter">The value to be checked for null.</param>
/// <param name = "exceptionFactory">The delegate that creates your custom exception.</param>
/// <exception cref = "Exception">Your custom exception thrown when <typeparamref name = "T"/> is a reference type and <paramref name = "parameter"/> is null.</exception>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
[ContractAnnotation("parameter:null => halt; parameter:notnull => notnull; exceptionFactory:null => halt")]
public static T MustNotBeNullReference<T>([ValidatedNotNull, NoEnumeration] this T parameter, Func<Exception> exceptionFactory)
{
if (default(T) != null)
return parameter;
if (parameter is null)
Throw.CustomException(exceptionFactory);
return parameter;
}
/// <summary>
/// Ensures that <paramref name = "parameter"/> can be cast to <typeparamref name = "T"/> and returns the cast value, or otherwise throws a <see cref = "TypeCastException"/>.
/// </summary>
/// <param name = "parameter">The value to be cast.</param>
/// <param name = "parameterName">The name of the parameter (optional).</param>
/// <param name = "message">The message that will be passed to the resulting exception (optional).</param>
/// <exception cref = "TypeCastException">Thrown when <paramref name = "parameter"/> cannot be cast to <typeparamref name = "T"/>.</exception>
/// <exception cref = "ArgumentNullException">Thrown when <paramref name = "parameter"/> is null.</exception>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
[ContractAnnotation("parameter:null => halt; parameter:notnull => notnull")]
public static T MustBeOfType<T>([ValidatedNotNull, NoEnumeration] this object? parameter, [CallerArgumentExpression("parameter")] string? parameterName = null, string? message = null)
{
if (parameter.MustNotBeNull(parameterName, message)is T castValue)
return castValue;
Throw.InvalidTypeCast(parameter, typeof(T), parameterName, message);
return default;
}
/// <summary>
/// Ensures that <paramref name = "parameter"/> can be cast to <typeparamref name = "T"/> and returns the cast value, or otherwise throws your custom exception.
/// </summary>
/// <param name = "parameter">The value to be cast.</param>
/// <param name = "exceptionFactory">The delegate that creates your custom exception. The <paramref name = "parameter"/> is passed to this delegate.</param>
/// <exception cref = "Exception">Your custom exception thrown when <paramref name = "parameter"/> cannot be cast to <typeparamref name = "T"/>.</exception>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
[ContractAnnotation("parameter:null => halt; parameter:notnull => notnull; exceptionFactory:null => halt")]
public static T MustBeOfType<T>([ValidatedNotNull, NoEnumeration] this object? parameter, Func<object?, Exception> exceptionFactory)
{
if (parameter is T castValue)
return castValue;
Throw.CustomException(exceptionFactory, parameter);
return default;
}
/// <summary>
/// Checks if the specified value is a valid enum value of its type. This is true when the specified value
/// is one of the constants defined in the enum, or a valid flags combination when the enum type is marked
/// with the <see cref = "FlagsAttribute"/>.
/// </summary>
/// <typeparam name = "T">The type of the enum.</typeparam>
/// <param name = "parameter">The enum value to be checked.</param>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
public static bool IsValidEnumValue<T>(this T parameter)
where T : Enum => EnumInfo<T>.IsValidEnumValue(parameter);
/// <summary>
/// Ensures that the specified enum value is valid, or otherwise throws an <see cref = "EnumValueNotDefinedException"/>. An enum value
/// is valid when the specified value is one of the constants defined in the enum, or a valid flags combination when the enum type
/// is marked with the <see cref = "FlagsAttribute"/>.
/// </summary>
/// <typeparam name = "T">The type of the enum.</typeparam>
/// <param name = "parameter">The value to be checked.</param>
/// <param name = "parameterName">The name of the parameter (optional).</param>
/// <param name = "message">The message that will be passed to the resulting exception (optional).</param>
/// <exception cref = "EnumValueNotDefinedException">Thrown when <paramref name = "parameter"/> is no valid enum value.</exception>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
public static T MustBeValidEnumValue<T>(this T parameter, [CallerArgumentExpression("parameter")] string? parameterName = null, string? message = null)
where T : Enum
{
if (!EnumInfo<T>.IsValidEnumValue(parameter))
Throw.EnumValueNotDefined(parameter, parameterName, message);
return parameter;
}
/// <summary>
/// Ensures that the specified enum value is valid, or otherwise throws your custom exception. An enum value
/// is valid when the specified value is one of the constants defined in the enum, or a valid flags combination when the enum type
/// is marked with the <see cref = "FlagsAttribute"/>.
/// </summary>
/// <typeparam name = "T">The type of the enum.</typeparam>
/// <param name = "parameter">The value to be checked.</param>
/// <param name = "exceptionFactory">The delegate that creates your custom exception. The <paramref name = "parameter"/> is passed to this delegate.</param>
/// <exception cref = "Exception">Your custom exception thrown when <paramref name = "parameter"/> is no valid enum value, or when <typeparamref name = "T"/> is no enum type.</exception>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
[ContractAnnotation("exceptionFactory:null => halt")]
public static T MustBeValidEnumValue<T>(this T parameter, Func<T, Exception> exceptionFactory)
where T : Enum
{
if (!EnumInfo<T>.IsValidEnumValue(parameter))
Throw.CustomException(exceptionFactory, parameter);
return parameter;
}
/// <summary>
/// Checks if the specified GUID is an empty one.
/// </summary>
/// <param name = "parameter">The GUID to be checked.</param>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
public static bool IsEmpty(this Guid parameter) => parameter == Guid.Empty;
/// <summary>
/// Ensures that the specified GUID is not empty, or otherwise throws an <see cref = "EmptyGuidException"/>.
/// </summary>
/// <param name = "parameter">The GUID to be checked.</param>
/// <param name = "parameterName">The name of the parameter (optional).</param>
/// <param name = "message">The message that will be passed to the resulting exception (optional).</param>
/// <exception cref = "EmptyGuidException">Thrown when <paramref name = "parameter"/> is an empty GUID.</exception>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
public static Guid MustNotBeEmpty(this Guid parameter, [CallerArgumentExpression("parameter")] string? parameterName = null, string? message = null)
{
if (parameter == Guid.Empty)
Throw.EmptyGuid(parameterName, message);
return parameter;
}
/// <summary>
/// Ensures that the specified GUID is not empty, or otherwise throws your custom exception.
/// </summary>
/// <param name = "parameter">The GUID to be checked.</param>
/// <param name = "exceptionFactory">The delegate that creates your custom exception.</param>
/// <exception cref = "Exception">Your custom exception thrown when <paramref name = "parameter"/> is an empty GUID.</exception>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
[ContractAnnotation("exceptionFactory:null => halt")]
public static Guid MustNotBeEmpty(this Guid parameter, Func<Exception> exceptionFactory)
{
if (parameter == Guid.Empty)
Throw.CustomException(exceptionFactory);
return parameter;
}
/// <summary>
/// Checks if the specified <paramref name = "condition"/> is true and throws an <see cref = "InvalidOperationException"/> in this case.
/// </summary>
/// <param name = "condition">The condition to be checked. The exception is thrown when it is true.</param>
/// <param name = "message">The message that will be passed to the <see cref = "InvalidOperationException"/> (optional).</param>
/// <exception cref = "InvalidOperationException">Thrown when <paramref name = "condition"/> is true.</exception>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
public static void InvalidOperation(bool condition, string? message = null)
{
if (condition)
Throw.InvalidOperation(message);
}
/// <summary>
/// Checks if the specified <paramref name = "condition"/> is true and throws an <see cref = "InvalidStateException"/> in this case.
/// </summary>
/// <param name = "condition">The condition to be checked. The exception is thrown when it is true.</param>
/// <param name = "message">The message that will be passed to the <see cref = "InvalidStateException"/>.</param>
/// <exception cref = "InvalidStateException">Thrown when <paramref name = "condition"/> is true.</exception>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
public static void InvalidState(bool condition, string? message = null)
{
if (condition)
Throw.InvalidState(message);
}
/// <summary>
/// Checks if the specified <paramref name = "condition"/> is true and throws an <see cref = "ArgumentException"/> in this case.
/// </summary>
/// <param name = "condition">The condition to be checked. The exception is thrown when it is true.</param>
/// <param name = "parameterName">The name of the parameter (optional).</param>
/// <param name = "message">The message that will be passed to the <see cref = "ArgumentException"/> (optional).</param>
/// <exception cref = "ArgumentException">Thrown when <paramref name = "condition"/> is true.</exception>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
public static void InvalidArgument(bool condition, string? parameterName = null, string? message = null)
{
if (condition)
Throw.Argument(parameterName, message);
}
/// <summary>
/// Checks if the specified <paramref name = "condition"/> is true and throws your custom exception in this case.
/// </summary>
/// <param name = "condition">The condition to be checked. The exception is thrown when it is true.</param>
/// <param name = "exceptionFactory">The delegate that creates your custom exception.</param>
/// <exception cref = "Exception">Your custom exception thrown when <paramref name = "condition"/> is true.</exception>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
[ContractAnnotation("exceptionFactory:null => halt")]
public static void InvalidArgument(bool condition, Func<Exception> exceptionFactory)
{
if (condition)
Throw.CustomException(exceptionFactory);
}
/// <summary>
/// Checks if the specified <paramref name = "condition"/> is true and throws your custom exception in this case.
/// </summary>
/// <param name = "condition">The condition to be checked. The exception is thrown when it is true.</param>
/// <param name = "parameter">The value that is checked in the <paramref name = "condition"/>. This value is passed to the <paramref name = "exceptionFactory"/>.</param>
/// <param name = "exceptionFactory">The delegate that creates your custom exception. The <paramref name = "parameter"/> is passed to this delegate.</param>
/// <exception cref = "Exception">Your custom exception thrown when <paramref name = "condition"/> is true.</exception>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
[ContractAnnotation("exceptionFactory:null => halt")]
public static void InvalidArgument<T>(bool condition, T parameter, Func<T, Exception> exceptionFactory)
{
if (condition)
Throw.CustomException(exceptionFactory, parameter);
}
/// <summary>
/// Ensures that the specified nullable has a value and returns it, or otherwise throws a <see cref = "NullableHasNoValueException"/>.
/// </summary>
/// <param name = "parameter">The nullable to be checked.</param>
/// <param name = "parameterName">The name of the parameter (optional).</param>
/// <param name = "message">The message that will be passed to the resulting exception (optional).</param>
/// <exception cref = "NullableHasNoValueException">Thrown when <paramref name = "parameter"/> has no value.</exception>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
public static T MustHaveValue<T>([NoEnumeration] this T? parameter, [CallerArgumentExpression("parameter")] string? parameterName = null, string? message = null)
where T : struct
{
if (!parameter.HasValue)
Throw.NullableHasNoValue(parameterName, message);
return parameter.Value;
}
/// <summary>
/// Ensures that the specified nullable has a value and returns it, or otherwise throws your custom exception.
/// </summary>
/// <param name = "parameter">The nullable to be checked.</param>
/// <param name = "exceptionFactory">The delegate that creates your custom exception.</param>
/// <exception cref = "NullableHasNoValueException">Thrown when <paramref name = "parameter"/> has no value.</exception>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
[ContractAnnotation("exceptionFactory:null => halt")]
public static T MustHaveValue<T>([NoEnumeration] this T? parameter, Func<Exception> exceptionFactory)
where T : struct
{
if (!parameter.HasValue)
Throw.CustomException(exceptionFactory);
return parameter.Value;
}
/// <summary>
/// Checks if <paramref name = "parameter"/> and <paramref name = "other"/> point to the same object.
/// </summary>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
// ReSharper disable StringLiteralTypo
[ContractAnnotation("parameter:notNull => true, other:notnull; parameter:notNull => false, other:canbenull; other:notnull => true, parameter:notnull; other:notnull => false, parameter:canbenull")]
// ReSharper restore StringLiteralTypo
public static bool IsSameAs<T>([NoEnumeration] this T? parameter, [NoEnumeration] T? other)
where T : class => ReferenceEquals(parameter, other);
/// <summary>
/// Ensures that <paramref name = "parameter"/> and <paramref name = "other"/> do not point to the same object instance, or otherwise
/// throws a <see cref = "SameObjectReferenceException"/>.
/// </summary>
/// <param name = "parameter">The first reference to be checked.</param>
/// <param name = "other">The second reference to be checked.</param>
/// <param name = "parameterName">The name of the parameter (optional).</param>
/// <param name = "message">The message that will be passed to the resulting exception (optional).</param>
/// <exception cref = "SameObjectReferenceException">Thrown when both <paramref name = "parameter"/> and <paramref name = "other"/> point to the same object.</exception>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
public static T? MustNotBeSameAs<T>([NoEnumeration] this T? parameter, [NoEnumeration] T? other, [CallerArgumentExpression("parameter")] string? parameterName = null, string? message = null)
where T : class
{
if (ReferenceEquals(parameter, other))
Throw.SameObjectReference(parameter, parameterName, message);
return parameter;
}
/// <summary>
/// Ensures that <paramref name = "parameter"/> and <paramref name = "other"/> do not point to the same object instance, or otherwise
/// throws your custom exception.
/// </summary>
/// <param name = "parameter">The first reference to be checked.</param>
/// <param name = "other">The second reference to be checked.</param>
/// <param name = "exceptionFactory">The delegate that creates your custom exception. <paramref name = "parameter"/> is passed to this delegate.</param>
/// <exception cref = "SameObjectReferenceException">Thrown when both <paramref name = "parameter"/> and <paramref name = "other"/> point to the same object.</exception>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
public static T? MustNotBeSameAs<T>([NoEnumeration] this T? parameter, T? other, Func<T?, Exception> exceptionFactory)
where T : class
{
if (ReferenceEquals(parameter, other))
Throw.CustomException(exceptionFactory, parameter);
return parameter;
}
/// <summary>
/// Ensures that <paramref name = "parameter"/> is equal to <paramref name = "other"/> using the default equality comparer, or otherwise throws a <see cref = "ValuesNotEqualException"/>.
/// </summary>
/// <param name = "parameter">The first value to be compared.</param>
/// <param name = "other">The other value to be compared.</param>
/// <param name = "parameterName">The name of the parameter (optional).</param>
/// <param name = "message">The message that will be passed to the resulting exception (optional).</param>
/// <exception cref = "ValuesNotEqualException">Thrown when <paramref name = "parameter"/> and <paramref name = "other"/> are not equal.</exception>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
public static T MustBe<T>(this T parameter, T other, [CallerArgumentExpression("parameter")] string? parameterName = null, string? message = null)
{
if (!EqualityComparer<T>.Default.Equals(parameter, other))
Throw.ValuesNotEqual(parameter, other, parameterName, message);
return parameter;
}
/// <summary>
/// Ensures that <paramref name = "parameter"/> is equal to <paramref name = "other"/> using the default equality comparer, or otherwise throws your custom exception.
/// </summary>
/// <param name = "parameter">The first value to be compared.</param>
/// <param name = "other">The other value to be compared.</param>
/// <param name = "exceptionFactory">The delegate that creates your custom exception. <paramref name = "parameter"/> and <paramref name = "other"/> are passed to this delegate.</param>
/// <exception cref = "Exception">Your custom exception thrown when <paramref name = "parameter"/> and <paramref name = "other"/> are not equal.</exception>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
public static T MustBe<T>(this T parameter, T other, Func<T, T, Exception> exceptionFactory)
{
if (!EqualityComparer<T>.Default.Equals(parameter, other))
Throw.CustomException(exceptionFactory, parameter, other);
return parameter;
}
/// <summary>
/// Ensures that <paramref name = "parameter"/> is equal to <paramref name = "other"/> using the specified equality comparer, or otherwise throws a <see cref = "ValuesNotEqualException"/>.
/// </summary>
/// <param name = "parameter">The first value to be compared.</param>
/// <param name = "other">The other value to be compared.</param>
/// <param name = "equalityComparer">The equality comparer used for comparing the two values.</param>
/// <param name = "parameterName">The name of the parameter (optional).</param>
/// <param name = "message">The message that will be passed to the resulting exception (optional).</param>
/// <exception cref = "ValuesNotEqualException">Thrown when <paramref name = "parameter"/> and <paramref name = "other"/> are not equal.</exception>
/// <exception cref = "ArgumentNullException">Thrown when <paramref name = "equalityComparer"/> is null.</exception>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
[ContractAnnotation("equalityComparer:null => halt")]
public static T MustBe<T>(this T parameter, T other, IEqualityComparer<T> equalityComparer, [CallerArgumentExpression("parameter")] string? parameterName = null, string? message = null)
{
if (!equalityComparer.MustNotBeNull(nameof(equalityComparer), message).Equals(parameter, other))
Throw.ValuesNotEqual(parameter, other, parameterName, message);
return parameter;
}
/// <summary>
/// Ensures that <paramref name = "parameter"/> is equal to <paramref name = "other"/> using the specified equality comparer, or otherwise throws your custom exception.
/// </summary>
/// <param name = "parameter">The first value to be compared.</param>
/// <param name = "other">The other value to be compared.</param>
/// <param name = "equalityComparer">The equality comparer used for comparing the two values.</param>
/// <param name = "exceptionFactory">The delegate that creates your custom exception. <paramref name = "parameter"/>, <paramref name = "other"/>, and <paramref name = "equalityComparer"/> are passed to this delegate.</param>
/// <exception cref = "Exception">Your custom exception thrown when <paramref name = "parameter"/> and <paramref name = "other"/> are not equal, or when <paramref name = "equalityComparer"/> is null.</exception>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
[ContractAnnotation("equalityComparer:null => halt")]
public static T MustBe<T>(this T parameter, T other, IEqualityComparer<T> equalityComparer, Func<T, T, IEqualityComparer<T>, Exception> exceptionFactory)
{
// ReSharper disable once ConditionIsAlwaysTrueOrFalseAccordingToNullableAPIContract - caller might have NRTs turned off
if (equalityComparer is null || !equalityComparer.Equals(parameter, other))
Throw.CustomException(exceptionFactory, parameter, other, equalityComparer!);
return parameter;
}
/// <summary>
/// Ensures that <paramref name = "parameter"/> is not equal to <paramref name = "other"/> using the default equality comparer, or otherwise throws a <see cref = "ValuesEqualException"/>.
/// </summary>
/// <param name = "parameter">The first value to be compared.</param>
/// <param name = "other">The other value to be compared.</param>
/// <param name = "parameterName">The name of the parameter (optional).</param>
/// <param name = "message">The message that will be passed to the resulting exception (optional).</param>
/// <exception cref = "ValuesEqualException">Thrown when <paramref name = "parameter"/> and <paramref name = "other"/> are equal.</exception>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
public static T MustNotBe<T>(this T parameter, T other, [CallerArgumentExpression("parameter")] string? parameterName = null, string? message = null)
{
if (EqualityComparer<T>.Default.Equals(parameter, other))
Throw.ValuesEqual(parameter, other, parameterName, message);
return parameter;
}
/// <summary>
/// Ensures that <paramref name = "parameter"/> is not equal to <paramref name = "other"/> using the default equality comparer, or otherwise throws your custom exception.
/// </summary>
/// <param name = "parameter">The first value to be compared.</param>
/// <param name = "other">The other value to be compared.</param>
/// <param name = "exceptionFactory">The delegate that creates your custom exception. <paramref name = "parameter"/> and <paramref name = "other"/> are passed to this delegate.</param>
/// <exception cref = "Exception">Your custom exception thrown when <paramref name = "parameter"/> and <paramref name = "other"/> are equal.</exception>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
public static T MustNotBe<T>(this T parameter, T other, Func<T, T, Exception> exceptionFactory)
{
if (EqualityComparer<T>.Default.Equals(parameter, other))
Throw.CustomException(exceptionFactory, parameter, other);
return parameter;
}
/// <summary>
/// Ensures that <paramref name = "parameter"/> is not equal to <paramref name = "other"/> using the specified equality comparer, or otherwise throws a <see cref = "ValuesEqualException"/>.
/// </summary>
/// <param name = "parameter">The first value to be compared.</param>
/// <param name = "other">The other value to be compared.</param>
/// <param name = "equalityComparer">The equality comparer used for comparing the two values.</param>
/// <param name = "parameterName">The name of the parameter (optional).</param>
/// <param name = "message">The message that will be passed to the resulting exception (optional).</param>
/// <exception cref = "ValuesEqualException">Thrown when <paramref name = "parameter"/> and <paramref name = "other"/> are equal.</exception>
/// <exception cref = "ArgumentNullException">Thrown when <paramref name = "equalityComparer"/> is null.</exception>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
[ContractAnnotation("equalityComparer:null => halt")]
public static T MustNotBe<T>(this T parameter, T other, IEqualityComparer<T> equalityComparer, [CallerArgumentExpression("parameter")] string? parameterName = null, string? message = null)
{
if (equalityComparer.MustNotBeNull(nameof(equalityComparer), message).Equals(parameter, other))
Throw.ValuesEqual(parameter, other, parameterName, message);
return parameter;
}
/// <summary>
/// Ensures that <paramref name = "parameter"/> is not equal to <paramref name = "other"/> using the specified equality comparer, or otherwise throws your custom exception.
/// </summary>
/// <param name = "parameter">The first value to be compared.</param>
/// <param name = "other">The other value to be compared.</param>
/// <param name = "equalityComparer">The equality comparer used for comparing the two values.</param>
/// <param name = "exceptionFactory">The delegate that creates your custom exception. <paramref name = "parameter"/>, <paramref name = "other"/>, and <paramref name = "equalityComparer"/> are passed to this delegate.</param>
/// <exception cref = "Exception">Your custom exception thrown when <paramref name = "parameter"/> and <paramref name = "other"/> are equal, or when <paramref name = "equalityComparer"/> is null.</exception>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
[ContractAnnotation("equalityComparer:null => halt")]
public static T MustNotBe<T>(this T parameter, T other, IEqualityComparer<T> equalityComparer, Func<T, T, IEqualityComparer<T>, Exception> exceptionFactory)
{
// ReSharper disable once ConditionIsAlwaysTrueOrFalseAccordingToNullableAPIContract - caller might have NRTs turned off
if (equalityComparer is null || equalityComparer.Equals(parameter, other))
Throw.CustomException(exceptionFactory, parameter, other, equalityComparer!);
return parameter;
}
/// <summary>
/// Checks if the specified value is approximately the same as the other value, using the given tolerance.
/// </summary>
/// <param name = "value">The first value to be compared.</param>
/// <param name = "other">The second value to be compared.</param>
/// <param name = "tolerance">The tolerance indicating how much the two values may differ from each other.</param>
/// <returns>
/// True if <paramref name = "value"/> and <paramref name = "other"/> are equal or if their absolute difference
/// is smaller than the given <paramref name = "tolerance"/>, otherwise false.
/// </returns>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
public static bool IsApproximately(this double value, double other, double tolerance) => Math.Abs(value - other) < tolerance;
/// <summary>
/// Checks if the specified value is approximately the same as the other value, using the default tolerance of 0.0001.
/// </summary>
/// <param name = "value">The first value to be compared.</param>
/// <param name = "other">The second value to be compared.</param>
/// <returns>
/// True if <paramref name = "value"/> and <paramref name = "other"/> are equal or if their absolute difference
/// is smaller than 0.0001, otherwise false.
/// </returns>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
public static bool IsApproximately(this double value, double other) => Math.Abs(value - other) < 0.0001;
/// <summary>
/// Checks if the specified value is approximately the same as the other value, using the given tolerance.
/// </summary>
/// <param name = "value">The first value to compare.</param>
/// <param name = "other">The second value to compare.</param>
/// <param name = "tolerance">The tolerance indicating how much the two values may differ from each other.</param>
/// <returns>
/// True if <paramref name = "value"/> and <paramref name = "other"/> are equal or if their absolute difference
/// is smaller than the given <paramref name = "tolerance"/>, otherwise false.
/// </returns>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
public static bool IsApproximately(this float value, float other, float tolerance) => Math.Abs(value - other) < tolerance;
/// <summary>
/// Checks if the specified value is approximately the same as the other value, using the default tolerance of 0.0001f.
/// </summary>
/// <param name = "value">The first value to be compared.</param>
/// <param name = "other">The second value to be compared.</param>
/// <returns>
/// True if <paramref name = "value"/> and <paramref name = "other"/> are equal or if their absolute difference
/// is smaller than 0.0001f, otherwise false.
/// </returns>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
public static bool IsApproximately(this float value, float other) => Math.Abs(value - other) < 0.0001f;
/// <summary>
/// Checks if the specified value is greater than or approximately the same as the other value, using the given tolerance.
/// </summary>
/// <param name = "value">The first value to compare.</param>
/// <param name = "other">The second value to compare.</param>
/// <param name = "tolerance">The tolerance indicating how much the two values may differ from each other.</param>
/// <returns>
/// True if <paramref name = "value"/> is greater than <paramref name = "other"/> or if their absolute difference
/// is smaller than the given <paramref name = "tolerance"/>, otherwise false.
/// </returns>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
public static bool IsGreaterThanOrApproximately(this double value, double other, double tolerance) => value > other || value.IsApproximately(other, tolerance);
/// <summary>
/// Checks if the specified value is greater than or approximately the same as the other value, using the default tolerance of 0.0001.
/// </summary>
/// <param name = "value">The first value to compare.</param>
/// <param name = "other">The second value to compare.</param>
/// <returns>
/// True if <paramref name = "value"/> is greater than <paramref name = "other"/> or if their absolute difference
/// is smaller than 0.0001, otherwise false.
/// </returns>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
public static bool IsGreaterThanOrApproximately(this double value, double other) => value > other || value.IsApproximately(other);
/// <summary>
/// Checks if the specified value is greater than or approximately the same as the other value, using the given tolerance.
/// </summary>
/// <param name = "value">The first value to compare.</param>
/// <param name = "other">The second value to compare.</param>
/// <param name = "tolerance">The tolerance indicating how much the two values may differ from each other.</param>
/// <returns>
/// True if <paramref name = "value"/> is greater than <paramref name = "other"/> or if their absolute difference
/// is smaller than the given <paramref name = "tolerance"/>, otherwise false.
/// </returns>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
public static bool IsGreaterThanOrApproximately(this float value, float other, float tolerance) => value > other || value.IsApproximately(other, tolerance);
/// <summary>
/// Checks if the specified value is greater than or approximately the same as the other value, using the default tolerance of 0.0001f.
/// </summary>
/// <param name = "value">The first value to compare.</param>
/// <param name = "other">The second value to compare.</param>
/// <returns>
/// True if <paramref name = "value"/> is greater than <paramref name = "other"/> or if their absolute difference
/// is smaller than 0.0001, otherwise false.
/// </returns>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
public static bool IsGreaterThanOrApproximately(this float value, float other) => value > other || value.IsApproximately(other);
/// <summary>
/// Checks if the specified value is less than or approximately the same as the other value, using the given tolerance.
/// </summary>
/// <param name = "value">The first value to compare.</param>
/// <param name = "other">The second value to compare.</param>
/// <param name = "tolerance">The tolerance indicating how much the two values may differ from each other.</param>
/// <returns>
/// True if <paramref name = "value"/> is less than <paramref name = "other"/> or if their absolute difference
/// is smaller than the given <paramref name = "tolerance"/>, otherwise false.
/// </returns>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
public static bool IsLessThanOrApproximately(this double value, double other, double tolerance) => value < other || value.IsApproximately(other, tolerance);
/// <summary>
/// Checks if the specified value is less than or approximately the same as the other value, using the default tolerance of 0.0001.
/// </summary>
/// <param name = "value">The first value to compare.</param>
/// <param name = "other">The second value to compare.</param>
/// <returns>
/// True if <paramref name = "value"/> is less than <paramref name = "other"/> or if their absolute difference
/// is smaller than 0.0001, otherwise false.
/// </returns>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
public static bool IsLessThanOrApproximately(this double value, double other) => value < other || value.IsApproximately(other);
/// <summary>
/// Checks if the specified value is less than or approximately the same as the other value, using the given tolerance.
/// </summary>
/// <param name = "value">The first value to compare.</param>
/// <param name = "other">The second value to compare.</param>
/// <param name = "tolerance">The tolerance indicating how much the two values may differ from each other.</param>
/// <returns>
/// True if <paramref name = "value"/> is less than <paramref name = "other"/> or if their absolute difference
/// is smaller than the given <paramref name = "tolerance"/>, otherwise false.
/// </returns>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
public static bool IsLessThanOrApproximately(this float value, float other, float tolerance) => value < other || value.IsApproximately(other, tolerance);
/// <summary>
/// Checks if the specified value is less than or approximately the same as the other value, using the default tolerance of 0.0001f.
/// </summary>
/// <param name = "value">The first value to compare.</param>
/// <param name = "other">The second value to compare.</param>
/// <returns>
/// True if <paramref name = "value"/> is less than <paramref name = "other"/> or if their absolute difference
/// is smaller than 0.0001f, otherwise false.
/// </returns>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
public static bool IsLessThanOrApproximately(this float value, float other) => value < other || value.IsApproximately(other);
/*
* -------------------------------------
* Must Not Be Less Than
* Must Be Greater Than or Equal To
* -------------------------------------
*/
/// <summary>
/// Ensures that the specified <paramref name = "parameter"/> is not less than the given <paramref name = "other"/> value, or otherwise throws an <see cref = "ArgumentOutOfRangeException"/>.
/// </summary>
/// <param name = "parameter">The comparable to be checked.</param>
/// <param name = "other">The boundary value that must be less than or equal to <paramref name = "parameter"/>.</param>
/// <param name = "parameterName">The name of the parameter (optional).</param>
/// <param name = "message">The message that will be passed to the resulting exception (optional).</param>
/// <exception cref = "ArgumentOutOfRangeException">Thrown when the specified <paramref name = "parameter"/> is less than <paramref name = "other"/>.</exception>
/// <exception cref = "ArgumentNullException">Thrown when <paramref name = "parameter"/> is null.</exception>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
[ContractAnnotation("parameter:null => halt; parameter:notnull => notnull")]
public static T MustNotBeLessThan<T>([ValidatedNotNull] this T parameter, T other, [CallerArgumentExpression("parameter")] string? parameterName = null, string? message = null)
where T : IComparable<T>
{
if (parameter.MustNotBeNullReference(parameterName, message).CompareTo(other) < 0)
Throw.MustNotBeLessThan(parameter, other, parameterName, message);
return parameter;
}
/// <summary>
/// Ensures that the specified <paramref name = "parameter"/> is not less than the given <paramref name = "other"/> value, or otherwise throws your custom exception.
/// </summary>
/// <param name = "parameter">The comparable to be checked.</param>
/// <param name = "other">The boundary value that must be less than or equal to <paramref name = "parameter"/>.</param>
/// <param name = "exceptionFactory">The delegate that creates your custom exception. <paramref name = "parameter"/> and <paramref name = "other"/> are passed to this delegate.</param>
/// <exception cref = "Exception">Your custom exception thrown when the specified <paramref name = "parameter"/> is less than <paramref name = "other"/>, or when <paramref name = "parameter"/> is null.</exception>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
[ContractAnnotation("parameter:null => halt; parameter:notnull => notnull; exceptionFactory:null => halt")]
public static T MustNotBeLessThan<T>([ValidatedNotNull] this T parameter, T other, Func<T, T, Exception> exceptionFactory)
where T : IComparable<T>
{
// ReSharper disable once ConditionIsAlwaysTrueOrFalse - caller might have NRTs turned off
if (parameter is null || parameter.CompareTo(other) < 0)
Throw.CustomException(exceptionFactory, parameter!, other);
return parameter;
}
/// <summary>
/// Ensures that the specified <paramref name = "parameter"/> is not less than the given <paramref name = "other"/> value, or otherwise throws an <see cref = "ArgumentOutOfRangeException"/>.
/// </summary>
/// <param name = "parameter">The comparable to be checked.</param>
/// <param name = "other">The boundary value that must be less than or equal to <paramref name = "parameter"/>.</param>
/// <param name = "parameterName">The name of the parameter (optional).</param>
/// <param name = "message">The message that will be passed to the resulting exception (optional).</param>
/// <exception cref = "ArgumentOutOfRangeException">Thrown when the specified <paramref name = "parameter"/> is less than <paramref name = "other"/>.</exception>
/// <exception cref = "ArgumentNullException">Thrown when <paramref name = "parameter"/> is null.</exception>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
[ContractAnnotation("parameter:null => halt; parameter:notnull => notnull")]
public static T MustBeGreaterThanOrEqualTo<T>([ValidatedNotNull] this T parameter, T other, [CallerArgumentExpression("parameter")] string? parameterName = null, string? message = null)
where T : IComparable<T>
{
if (parameter.MustNotBeNullReference(parameterName, message).CompareTo(other) < 0)
Throw.MustBeGreaterThanOrEqualTo(parameter, other, parameterName, message);
return parameter;
}
/// <summary>
/// Ensures that the specified <paramref name = "parameter"/> is not less than the given <paramref name = "other"/> value, or otherwise throws your custom exception.
/// </summary>
/// <param name = "parameter">The comparable to be checked.</param>
/// <param name = "other">The boundary value that must be less than or equal to <paramref name = "parameter"/>.</param>
/// <param name = "exceptionFactory">The delegate that creates your custom exception. <paramref name = "parameter"/> and <paramref name = "other"/> are passed to this delegate.</param>
/// <exception cref = "Exception">Your custom exception thrown when the specified <paramref name = "parameter"/> is less than <paramref name = "other"/>, or when <paramref name = "parameter"/> is null.</exception>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
[ContractAnnotation("parameter:null => halt; parameter:notnull => notnull; exceptionFactory:null => halt")]
public static T MustBeGreaterThanOrEqualTo<T>([ValidatedNotNull] this T parameter, T other, Func<T, T, Exception> exceptionFactory)
where T : IComparable<T>
{
// ReSharper disable once ConditionIsAlwaysTrueOrFalse - caller might have NRTs turned off
if (parameter is null || parameter.CompareTo(other) < 0)
Throw.CustomException(exceptionFactory, parameter!, other);
return parameter;
}
/*
* -------------------------------------
* Must Be Less Than
* Must Not Be Greater Than or Equal To
* -------------------------------------
*/
/// <summary>
/// Ensures that the specified <paramref name = "parameter"/> is less than the given <paramref name = "other"/> value, or otherwise throws an <see cref = "ArgumentOutOfRangeException"/>.
/// </summary>
/// <param name = "parameter">The comparable to be checked.</param>
/// <param name = "other">The boundary value that must be greater than <paramref name = "parameter"/>.</param>
/// <param name = "parameterName">The name of the parameter (optional).</param>
/// <param name = "message">The message that will be passed to the resulting exception (optional).</param>
/// <exception cref = "ArgumentOutOfRangeException">Thrown when the specified <paramref name = "parameter"/> is not less than <paramref name = "other"/>.</exception>
/// <exception cref = "ArgumentNullException">Thrown when <paramref name = "parameter"/> is null.</exception>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
[ContractAnnotation("parameter:null => halt; parameter:notnull => notnull")]
public static T MustBeLessThan<T>([ValidatedNotNull] this T parameter, T other, [CallerArgumentExpression("parameter")] string? parameterName = null, string? message = null)
where T : IComparable<T>
{
if (parameter.MustNotBeNullReference(parameterName, message).CompareTo(other) >= 0)
Throw.MustBeLessThan(parameter, other, parameterName, message);
return parameter;
}
/// <summary>
/// Ensures that the specified <paramref name = "parameter"/> is less than the given <paramref name = "other"/> value, or otherwise throws your custom exception.
/// </summary>
/// <param name = "parameter">The comparable to be checked.</param>
/// <param name = "other">The boundary value that must be greater than <paramref name = "parameter"/>.</param>
/// <param name = "exceptionFactory">The delegate that creates your custom exception. <paramref name = "parameter"/> and <paramref name = "other"/> are passed to this delegate.</param>
/// <exception cref = "Exception">Your custom exception thrown when the specified <paramref name = "parameter"/> is not less than <paramref name = "other"/>, or when <paramref name = "parameter"/> is null.</exception>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
[ContractAnnotation("parameter:null => halt; parameter:notnull => notnull; exceptionFactory:null => halt")]
public static T MustBeLessThan<T>([ValidatedNotNull] this T parameter, T other, Func<T, T, Exception> exceptionFactory)
where T : IComparable<T>
{
// ReSharper disable once ConditionIsAlwaysTrueOrFalse - caller might have NRTs turned off
if (parameter is null || parameter.CompareTo(other) >= 0)
Throw.CustomException(exceptionFactory, parameter!, other);
return parameter;
}
/// <summary>
/// Ensures that the specified <paramref name = "parameter"/> is less than the given <paramref name = "other"/> value, or otherwise throws an <see cref = "ArgumentOutOfRangeException"/>.
/// </summary>
/// <param name = "parameter">The comparable to be checked.</param>
/// <param name = "other">The boundary value that must be greater than <paramref name = "parameter"/>.</param>
/// <param name = "parameterName">The name of the parameter (optional).</param>
/// <param name = "message">The message that will be passed to the resulting exception (optional).</param>
/// <exception cref = "ArgumentOutOfRangeException">Thrown when the specified <paramref name = "parameter"/> is not less than <paramref name = "other"/>.</exception>
/// <exception cref = "ArgumentNullException">Thrown when <paramref name = "parameter"/> is null.</exception>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
[ContractAnnotation("parameter:null => halt; parameter:notnull => notnull")]
public static T MustNotBeGreaterThanOrEqualTo<T>([ValidatedNotNull] this T parameter, T other, [CallerArgumentExpression("parameter")] string? parameterName = null, string? message = null)
where T : IComparable<T>
{
if (parameter.MustNotBeNullReference(parameterName, message).CompareTo(other) >= 0)
Throw.MustNotBeGreaterThanOrEqualTo(parameter, other, parameterName, message);
return parameter;
}
/// <summary>
/// Ensures that the specified <paramref name = "parameter"/> is less than the given <paramref name = "other"/> value, or otherwise throws your custom exception.
/// </summary>
/// <param name = "parameter">The comparable to be checked.</param>
/// <param name = "other">The boundary value that must be greater than <paramref name = "parameter"/>.</param>
/// <param name = "exceptionFactory">The delegate that creates your custom exception. <paramref name = "parameter"/> and <paramref name = "other"/> are passed to this delegate.</param>
/// <exception cref = "Exception">Your custom exception thrown when the specified <paramref name = "parameter"/> is not less than <paramref name = "other"/>, or when <paramref name = "parameter"/> is null.</exception>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
[ContractAnnotation("parameter:null => halt; parameter:notnull => notnull; exceptionFactory:null => halt")]
public static T MustNotBeGreaterThanOrEqualTo<T>([ValidatedNotNull] this T parameter, T other, Func<T, T, Exception> exceptionFactory)
where T : IComparable<T>
{
// ReSharper disable once ConditionIsAlwaysTrueOrFalse - caller might have NRTs turned off
if (parameter is null || parameter.CompareTo(other) >= 0)
Throw.CustomException(exceptionFactory, parameter!, other);
return parameter;
}
/*
* -------------------------------------
* Must Be Greater Than
* Must Not Be Less Than or Equal To
* -------------------------------------
*/
/// <summary>
/// Ensures that the specified <paramref name = "parameter"/> is greater than the given <paramref name = "other"/> value, or otherwise throws an <see cref = "ArgumentOutOfRangeException"/>.
/// </summary>
/// <param name = "parameter">The comparable to be checked.</param>
/// <param name = "other">The boundary value that must be less than <paramref name = "parameter"/>.</param>
/// <param name = "parameterName">The name of the parameter (optional).</param>
/// <param name = "message">The message that will be passed to the resulting exception (optional).</param>
/// <exception cref = "ArgumentOutOfRangeException">Thrown when the specified <paramref name = "parameter"/> is less than or equal to <paramref name = "other"/>.</exception>
/// <exception cref = "ArgumentNullException">Thrown when <paramref name = "parameter"/> is null.</exception>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
[ContractAnnotation("parameter:null => halt; parameter:notnull => notnull")]
public static T MustBeGreaterThan<T>([ValidatedNotNull] this T parameter, T other, [CallerArgumentExpression("parameter")] string? parameterName = null, string? message = null)
where T : IComparable<T>
{
if (parameter.MustNotBeNullReference(parameterName, message).CompareTo(other) <= 0)
Throw.MustBeGreaterThan(parameter, other, parameterName, message);
return parameter;
}
/// <summary>
/// Ensures that the specified <paramref name = "parameter"/> is greater than the given <paramref name = "other"/> value, or otherwise throws your custom exception.
/// </summary>
/// <param name = "parameter">The comparable to be checked.</param>
/// <param name = "other">The boundary value that must be less than <paramref name = "parameter"/>.</param>
/// <param name = "exceptionFactory">The delegate that creates your custom exception. <paramref name = "parameter"/> and <paramref name = "other"/> are passed to this delegate.</param>
/// <exception cref = "Exception">Your custom exception thrown when the specified <paramref name = "parameter"/> is less than or equal to <paramref name = "other"/>, or when <paramref name = "parameter"/> is null.</exception>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
[ContractAnnotation("parameter:null => halt; parameter:notnull => notnull; exceptionFactory:null => halt")]
public static T MustBeGreaterThan<T>([ValidatedNotNull] this T parameter, T other, Func<T, T, Exception> exceptionFactory)
where T : IComparable<T>
{
// ReSharper disable once ConditionIsAlwaysTrueOrFalse - caller might have NRTs turned off
if (parameter is null || parameter.CompareTo(other) <= 0)
Throw.CustomException(exceptionFactory, parameter!, other);
return parameter;
}
/// <summary>
/// Ensures that the specified <paramref name = "parameter"/> is greater than the given <paramref name = "other"/> value, or otherwise throws an <see cref = "ArgumentOutOfRangeException"/>.
/// </summary>
/// <param name = "parameter">The comparable to be checked.</param>
/// <param name = "other">The boundary value that must be less than <paramref name = "parameter"/>.</param>
/// <param name = "parameterName">The name of the parameter (optional).</param>
/// <param name = "message">The message that will be passed to the resulting exception (optional).</param>
/// <exception cref = "ArgumentOutOfRangeException">Thrown when the specified <paramref name = "parameter"/> is less than or equal to <paramref name = "other"/>.</exception>
/// <exception cref = "ArgumentNullException">Thrown when <paramref name = "parameter"/> is null.</exception>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
[ContractAnnotation("parameter:null => halt; parameter:notnull => notnull")]
public static T MustNotBeLessThanOrEqualTo<T>([ValidatedNotNull] this T parameter, T other, [CallerArgumentExpression("parameter")] string? parameterName = null, string? message = null)
where T : IComparable<T>
{
if (parameter.MustNotBeNullReference(parameterName, message).CompareTo(other) <= 0)
Throw.MustNotBeLessThanOrEqualTo(parameter, other, parameterName, message);
return parameter;
}
/// <summary>
/// Ensures that the specified <paramref name = "parameter"/> is greater than the given <paramref name = "other"/> value, or otherwise throws your custom exception.
/// </summary>
/// <param name = "parameter">The comparable to be checked.</param>
/// <param name = "other">The boundary value that must be less than <paramref name = "parameter"/>.</param>
/// <param name = "exceptionFactory">The delegate that creates your custom exception. <paramref name = "parameter"/> and <paramref name = "other"/> are passed to this delegate.</param>
/// <exception cref = "Exception">Your custom exception thrown when the specified <paramref name = "parameter"/> is less than or equal to <paramref name = "other"/>, or when <paramref name = "parameter"/> is null.</exception>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
[ContractAnnotation("parameter:null => halt; parameter:notnull => notnull; exceptionFactory:null => halt")]
public static T MustNotBeLessThanOrEqualTo<T>([ValidatedNotNull] this T parameter, T other, Func<T, T, Exception> exceptionFactory)
where T : IComparable<T>
{
// ReSharper disable once ConditionIsAlwaysTrueOrFalse - caller might have NRTs turned off
if (parameter is null || parameter.CompareTo(other) <= 0)
Throw.CustomException(exceptionFactory, parameter!, other);
return parameter;
}
/*
* -------------------------------------
* Must Not Be Greater Than
* Must Be Less Than or Equal To
* -------------------------------------
*/
/// <summary>
/// Ensures that the specified <paramref name = "parameter"/> is not greater than the given <paramref name = "other"/> value, or otherwise throws an <see cref = "ArgumentOutOfRangeException"/>.
/// </summary>
/// <param name = "parameter">The comparable to be checked.</param>
/// <param name = "other">The boundary value that must be greater than or equal to <paramref name = "parameter"/>.</param>
/// <param name = "parameterName">The name of the parameter (optional).</param>
/// <param name = "message">The message that will be passed to the resulting exception (optional).</param>
/// <exception cref = "ArgumentOutOfRangeException">Thrown when the specified <paramref name = "parameter"/> is greater than <paramref name = "other"/>.</exception>
/// <exception cref = "ArgumentNullException">Thrown when <paramref name = "parameter"/> is null.</exception>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
[ContractAnnotation("parameter:null => halt; parameter:notnull => notnull")]
public static T MustNotBeGreaterThan<T>([ValidatedNotNull] this T parameter, T other, [CallerArgumentExpression("parameter")] string? parameterName = null, string? message = null)
where T : IComparable<T>
{
if (parameter.MustNotBeNullReference(parameterName, message).CompareTo(other) > 0)
Throw.MustNotBeGreaterThan(parameter, other, parameterName, message);
return parameter;
}
/// <summary>
/// Ensures that the specified <paramref name = "parameter"/> is not greater than the given <paramref name = "other"/> value, or otherwise throws your custom exception.
/// </summary>
/// <param name = "parameter">The comparable to be checked.</param>
/// <param name = "other">The boundary value that must be greater than or equal to <paramref name = "parameter"/>.</param>
/// <param name = "exceptionFactory">The delegate that creates your custom exception. <paramref name = "parameter"/> and <paramref name = "other"/> are passed to this delegate.</param>
/// <exception cref = "Exception">Your custom exception thrown when the specified <paramref name = "parameter"/> is greater than <paramref name = "other"/>, or when <paramref name = "parameter"/> is null.</exception>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
[ContractAnnotation("parameter:null => halt; parameter:notnull => notnull; exceptionFactory:null => halt")]
public static T MustNotBeGreaterThan<T>([ValidatedNotNull] this T parameter, T other, Func<T, T, Exception> exceptionFactory)
where T : IComparable<T>
{
// ReSharper disable once ConditionIsAlwaysTrueOrFalse - caller might have NRTs turned off
if (parameter is null || parameter.CompareTo(other) > 0)
Throw.CustomException(exceptionFactory, parameter!, other);
return parameter;
}
/// <summary>
/// Ensures that the specified <paramref name = "parameter"/> is not greater than the given <paramref name = "other"/> value, or otherwise throws an <see cref = "ArgumentOutOfRangeException"/>.
/// </summary>
/// <param name = "parameter">The comparable to be checked.</param>
/// <param name = "other">The boundary value that must be greater than or equal to <paramref name = "parameter"/>.</param>
/// <param name = "parameterName">The name of the parameter (optional).</param>
/// <param name = "message">The message that will be passed to the resulting exception (optional).</param>
/// <exception cref = "ArgumentOutOfRangeException">Thrown when the specified <paramref name = "parameter"/> is greater than <paramref name = "other"/>.</exception>
/// <exception cref = "ArgumentNullException">Thrown when <paramref name = "parameter"/> is null.</exception>
[MethodImpl(MethodImplOptions.AggressiveInlining)]