.NET-Community-Toolkit/CommunityToolkit.HighPerformance/Streams/MemoryStream.ThrowExceptions.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;
using System.IO;

namespace CommunityToolkit.HighPerformance.Streams;

/// <inheritdoc/>
partial class MemoryStream
{
    /// <summary>
    /// Gets a standard <see cref="NotSupportedException"/> instance for a stream.
    /// </summary>
    /// <returns>A <see cref="NotSupportedException"/> with the standard text.</returns>
    public static Exception GetNotSupportedException()
    {
        return new NotSupportedException("The requested operation is not supported for this stream.");
    }

    /// <summary>
    /// Throws a <see cref="NotSupportedException"/> when trying to perform a not supported operation.
    /// </summary>
    public static void ThrowNotSupportedException()
    {
        throw GetNotSupportedException();
    }

    /// <summary>
    /// Throws an <see cref="ArgumentException"/> when trying to write too many bytes to the target stream.
    /// </summary>
    public static void ThrowArgumentExceptionForEndOfStreamOnWrite()
    {
        throw new ArgumentException("The current stream can't contain the requested input data.");
    }

    /// <summary>
    /// Throws an <see cref="ArgumentException"/> when using an invalid seek mode.
    /// </summary>
    /// <returns>Nothing, as this method throws unconditionally.</returns>
    public static long ThrowArgumentExceptionForSeekOrigin()
    {
        throw new ArgumentException("The input seek mode is not valid.", "origin");
    }

    /// <summary>
    /// Throws an <see cref="ArgumentOutOfRangeException"/> when setting the <see cref="Stream.Position"/> property.
    /// </summary>
    private static void ThrowArgumentOutOfRangeExceptionForPosition()
    {
        throw new ArgumentOutOfRangeException(nameof(Stream.Position), "The value for the property was not in the valid range.");
    }

    /// <summary>
    /// Throws an <see cref="ArgumentNullException"/> when an input buffer is <see langword="null"/>.
    /// </summary>
    private static void ThrowArgumentNullExceptionForBuffer()
    {
        throw new ArgumentNullException("buffer", "The buffer is null.");
    }

    /// <summary>
    /// Throws an <see cref="ArgumentOutOfRangeException"/> when the input count is negative.
    /// </summary>
    private static void ThrowArgumentOutOfRangeExceptionForOffset()
    {
        throw new ArgumentOutOfRangeException("offset", "Offset can't be negative.");
    }

    /// <summary>
    /// Throws an <see cref="ArgumentOutOfRangeException"/> when the input count is negative.
    /// </summary>
    private static void ThrowArgumentOutOfRangeExceptionForCount()
    {
        throw new ArgumentOutOfRangeException("count", "Count can't be negative.");
    }

    /// <summary>
    /// Throws an <see cref="ArgumentException"/> when the sum of offset and count exceeds the length of the target buffer.
    /// </summary>
    private static void ThrowArgumentExceptionForLength()
    {
        throw new ArgumentException("The sum of offset and count can't be larger than the buffer length.", "buffer");
    }

    /// <summary>
    /// Throws an <see cref="ObjectDisposedException"/> when using a disposed <see cref="Stream"/> instance.
    /// </summary>
    private static void ThrowObjectDisposedException()
    {
        throw new ObjectDisposedException("source", "The current stream has already been disposed");
    }
}