Fishery

2022-10-24 18:56:18 +02:00
parent 01ef055ff2
commit 9cdc8ccb4f
70 changed files with 19754 additions and 4 deletions
@@ -0,0 +1,144 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+// See the LICENSE file in the project root for more information.
+
+using System.Diagnostics.CodeAnalysis;
+
+namespace FisheryLib.Utility.Diagnostics;
+
+/// <inheritdoc/>
+public partial class Guard
+{
+	/// <summary>
+	/// Helper methods to efficiently throw exceptions.
+	/// </summary>
+	private static partial class ThrowHelper
+	{
+		/// <summary>
+		/// Returns a formatted representation of the input value.
+		/// </summary>
+		/// <param name="obj">The input <see cref="object"/> to format.</param>
+		/// <returns>A formatted representation of <paramref name="obj"/> to display in error messages.</returns>
+		private static string AssertString(object? obj)
+			=> obj switch
+			{
+				string _ => $"\"{obj}\"",
+				null => "null",
+				_ => $"<{obj}>"
+			};
+
+		/// <summary>
+		/// Throws an <see cref="ArgumentException"/> when <see cref="IsNull{T}(T,string)"/> (where <typeparamref name="T"/> is <see langword="class"/>) fails.
+		/// </summary>
+		/// <typeparam name="T">The type of the input value.</typeparam>
+		[DoesNotReturn]
+		public static void ThrowArgumentExceptionForIsNull<T>(T value, string name) => throw new ArgumentException($"Parameter {AssertString(name)} ({typeof(T).ToTypeString()}) must be null, was {AssertString(value)} ({value!.GetType().ToTypeString()}).", name);
+
+		/// <summary>
+		/// Throws an <see cref="ArgumentException"/> when <see cref="IsNull{T}(T,string)"/> (where <typeparamref name="T"/> is <see langword="struct"/>) fails.
+		/// </summary>
+		/// <typeparam name="T">The type of the input value.</typeparam>
+		[DoesNotReturn]
+		public static void ThrowArgumentExceptionForIsNull<T>(T? value, string name)
+			where T : struct => throw new ArgumentException($"Parameter {AssertString(name)} ({typeof(T?).ToTypeString()}) must be null, was {AssertString(value)} ({typeof(T).ToTypeString()}).", name);
+
+		/// <summary>
+		/// Throws an <see cref="ArgumentNullException"/> when <see cref="IsNotNull{T}(T,string)"/> fails.
+		/// </summary>
+		/// <typeparam name="T">The type of the input value.</typeparam>
+		[DoesNotReturn]
+		public static void ThrowArgumentNullExceptionForIsNotNull<T>(string name) => throw new ArgumentNullException(name, $"Parameter {AssertString(name)} ({typeof(T).ToTypeString()}) must be not null).");
+
+		/// <summary>
+		/// Throws an <see cref="ArgumentException"/> when <see cref="IsOfType{T}"/> fails.
+		/// </summary>
+		/// <typeparam name="T">The type of the input value.</typeparam>
+		[DoesNotReturn]
+		public static void ThrowArgumentExceptionForIsOfType<T>(object value, string name) => throw new ArgumentException($"Parameter {AssertString(name)} must be of type {typeof(T).ToTypeString()}, was {value.GetType().ToTypeString()}.", name);
+
+		/// <summary>
+		/// Throws an <see cref="ArgumentException"/> when <see cref="IsNotOfType{T}"/> fails.
+		/// </summary>
+		/// <typeparam name="T">The type of the input value.</typeparam>
+		[DoesNotReturn]
+		public static void ThrowArgumentExceptionForIsNotOfType<T>(object value, string name) => throw new ArgumentException($"Parameter {AssertString(name)} must not be of type {typeof(T).ToTypeString()}, was {value.GetType().ToTypeString()}.", name);
+
+		/// <summary>
+		/// Throws an <see cref="ArgumentException"/> when <see cref="IsOfType"/> fails.
+		/// </summary>
+		[DoesNotReturn]
+		public static void ThrowArgumentExceptionForIsOfType(object value, Type type, string name) => throw new ArgumentException($"Parameter {AssertString(name)} must be of type {type.ToTypeString()}, was {value.GetType().ToTypeString()}.", name);
+
+		/// <summary>
+		/// Throws an <see cref="ArgumentException"/> when <see cref="IsNotOfType"/> fails.
+		/// </summary>
+		[DoesNotReturn]
+		public static void ThrowArgumentExceptionForIsNotOfType(object value, Type type, string name) => throw new ArgumentException($"Parameter {AssertString(name)} must not be of type {type.ToTypeString()}, was {value.GetType().ToTypeString()}.", name);
+
+		/// <summary>
+		/// Throws an <see cref="ArgumentException"/> when <see cref="IsAssignableToType{T}"/> fails.
+		/// </summary>
+		/// <typeparam name="T">The type being checked against.</typeparam>
+		[DoesNotReturn]
+		public static void ThrowArgumentExceptionForIsAssignableToType<T>(object value, string name) => throw new ArgumentException($"Parameter {AssertString(name)} must be assignable to type {typeof(T).ToTypeString()}, was {value.GetType().ToTypeString()}.", name);
+
+		/// <summary>
+		/// Throws an <see cref="ArgumentException"/> when <see cref="IsNotAssignableToType{T}"/> fails.
+		/// </summary>
+		/// <typeparam name="T">The type being checked against.</typeparam>
+		[DoesNotReturn]
+		public static void ThrowArgumentExceptionForIsNotAssignableToType<T>(object value, string name) => throw new ArgumentException($"Parameter {AssertString(name)} must not be assignable to type {typeof(T).ToTypeString()}, was {value.GetType().ToTypeString()}.", name);
+
+		/// <summary>
+		/// Throws an <see cref="ArgumentException"/> when <see cref="IsAssignableToType"/> fails.
+		/// </summary>
+		[DoesNotReturn]
+		public static void ThrowArgumentExceptionForIsAssignableToType(object value, Type type, string name) => throw new ArgumentException($"Parameter {AssertString(name)} must be assignable to type {type.ToTypeString()}, was {value.GetType().ToTypeString()}.", name);
+
+		/// <summary>
+		/// Throws an <see cref="ArgumentException"/> when <see cref="IsAssignableToType"/> fails.
+		/// </summary>
+		[DoesNotReturn]
+		public static void ThrowArgumentExceptionForIsNotAssignableToType(object value, Type type, string name) => throw new ArgumentException($"Parameter {AssertString(name)} must not be assignable to type {type.ToTypeString()}, was {value.GetType().ToTypeString()}.", name);
+
+		/// <summary>
+		/// Throws an <see cref="ArgumentException"/> when <see cref="IsReferenceEqualTo{T}"/> fails.
+		/// </summary>
+		/// <typeparam name="T">The type of input value being compared.</typeparam>
+		[DoesNotReturn]
+		public static void ThrowArgumentExceptionForIsReferenceEqualTo<T>(string name)
+			where T : class => throw new ArgumentException($"Parameter {AssertString(name)} ({typeof(T).ToTypeString()}) must be the same instance as the target object.", name);
+
+		/// <summary>
+		/// Throws an <see cref="ArgumentException"/> when <see cref="IsReferenceNotEqualTo{T}"/> fails.
+		/// </summary>
+		/// <typeparam name="T">The type of input value being compared.</typeparam>
+		[DoesNotReturn]
+		public static void ThrowArgumentExceptionForIsReferenceNotEqualTo<T>(string name)
+			where T : class => throw new ArgumentException($"Parameter {AssertString(name)} ({typeof(T).ToTypeString()}) must not be the same instance as the target object.", name);
+
+		/// <summary>
+		/// Throws an <see cref="ArgumentException"/> when <see cref="IsTrue(bool,string)"/> fails.
+		/// </summary>
+		[DoesNotReturn]
+		public static void ThrowArgumentExceptionForIsTrue(string name) => throw new ArgumentException($"Parameter {AssertString(name)} must be true, was false.", name);
+
+		/// <summary>
+		/// Throws an <see cref="ArgumentException"/> when <see cref="IsTrue(bool,string,string)"/> fails.
+		/// </summary>
+		[DoesNotReturn]
+		public static void ThrowArgumentExceptionForIsTrue(string name, string message) => throw new ArgumentException($"Parameter {AssertString(name)} must be true, was false: {AssertString(message)}.", name);
+
+		/// <summary>
+		/// Throws an <see cref="ArgumentException"/> when <see cref="IsFalse(bool,string)"/> fails.
+		/// </summary>
+		[DoesNotReturn]
+		public static void ThrowArgumentExceptionForIsFalse(string name) => throw new ArgumentException($"Parameter {AssertString(name)} must be false, was true.", name);
+
+		/// <summary>
+		/// Throws an <see cref="ArgumentException"/> when <see cref="IsFalse(bool,string,string)"/> fails.
+		/// </summary>
+		[DoesNotReturn]
+		public static void ThrowArgumentExceptionForIsFalse(string name, string message) => throw new ArgumentException($"Parameter {AssertString(name)} must be false, was true: {AssertString(message)}.", name);
+	}
+}