.NET-Community-Toolkit/CommunityToolkit.HighPerformance/Memory/Internals/ThrowHelper.cs

// 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;

namespace CommunityToolkit.HighPerformance.Memory.Internals;

/// <summary>
/// A helper class to throw exceptions for memory types.
/// </summary>
internal static class ThrowHelper
{
    /// <summary>
    /// Throws an <see cref="ArgumentException"/> when using the <see langword="void"/>* constructor with a managed type.
    /// </summary>
    public static void ThrowArgumentExceptionForManagedType()
    {
        throw new ArgumentException("Can't use a void* constructor when T is a managed type.");
    }

    /// <summary>
    /// Throws an <see cref="ArgumentException"/> when the target span is too short.
    /// </summary>
    public static void ThrowArgumentExceptionForDestinationTooShort()
    {
        throw new ArgumentException("The target span is too short to copy all the current items to.");
    }

    /// <summary>
    /// Throws an <see cref="ArgumentException"/> when the target span does not have the same shape as the source.
    /// </summary>
    public static void ThrowArgumentExceptionForDestinationWithNotSameShape()
    {
        throw new ArgumentException("The target span does not have the same shape as the source one.");
    }

    /// <summary>
    /// Throws an <see cref="ArrayTypeMismatchException"/> when using an array of an invalid type.
    /// </summary>
    public static void ThrowArrayTypeMismatchException()
    {
        throw new ArrayTypeMismatchException("The given array doesn't match the specified type T.");
    }

    /// <summary>
    /// Throws an <see cref="ArgumentException"/> when using an array of an invalid type.
    /// </summary>
    public static void ThrowArgumentExceptionForUnsupportedType()
    {
        throw new ArgumentException("The specified object type is not supported.");
    }

    /// <summary>
    /// Throws an <see cref="IndexOutOfRangeException"/> when the a given coordinate is invalid.
    /// </summary>
    /// <remarks>
    /// Throwing <see cref="IndexOutOfRangeException"/> is technically discouraged in the docs, but
    /// we're doing that here for consistency with the official <see cref="Span{T}"/> type(s) from the BCL.
    /// </remarks>
    public static void ThrowIndexOutOfRangeException()
    {
        throw new IndexOutOfRangeException();
    }

    /// <summary>
    /// Throws an <see cref="ArgumentOutOfRangeException"/> when more than one parameter are invalid.
    /// </summary>
    public static void ThrowArgumentException()
    {
        throw new ArgumentException("One or more input parameters were invalid.");
    }

    /// <summary>
    /// Throws an <see cref="ArgumentOutOfRangeException"/> when the "depth" parameter is invalid.
    /// </summary>
    public static void ThrowArgumentOutOfRangeExceptionForDepth()
    {
        throw new ArgumentOutOfRangeException("depth");
    }

    /// <summary>
    /// Throws an <see cref="ArgumentOutOfRangeException"/> when the "row" parameter is invalid.
    /// </summary>
    public static void ThrowArgumentOutOfRangeExceptionForRow()
    {
        throw new ArgumentOutOfRangeException("row");
    }

    /// <summary>
    /// Throws an <see cref="ArgumentOutOfRangeException"/> when the "column" parameter is invalid.
    /// </summary>
    public static void ThrowArgumentOutOfRangeExceptionForColumn()
    {
        throw new ArgumentOutOfRangeException("column");
    }

    /// <summary>
    /// Throws an <see cref="ArgumentOutOfRangeException"/> when the "offset" parameter is invalid.
    /// </summary>
    public static void ThrowArgumentOutOfRangeExceptionForOffset()
    {
        throw new ArgumentOutOfRangeException("offset");
    }

    /// <summary>
    /// Throws an <see cref="ArgumentOutOfRangeException"/> when the "height" parameter is invalid.
    /// </summary>
    public static void ThrowArgumentOutOfRangeExceptionForHeight()
    {
        throw new ArgumentOutOfRangeException("height");
    }

    /// <summary>
    /// Throws an <see cref="ArgumentOutOfRangeException"/> when the "width" parameter is invalid.
    /// </summary>
    public static void ThrowArgumentOutOfRangeExceptionForWidth()
    {
        throw new ArgumentOutOfRangeException("width");
    }

    /// <summary>
    /// Throws an <see cref="ArgumentOutOfRangeException"/> when the "pitch" parameter is invalid.
    /// </summary>
    public static void ThrowArgumentOutOfRangeExceptionForPitch()
    {
        throw new ArgumentOutOfRangeException("pitch");
    }
}