/* ========================================================================
 * Copyright (c) 2005-2025 The OPC Foundation, Inc. All rights reserved.
 *
 * OPC Foundation MIT License 1.00
 *
 * 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.
 *
 * The complete license agreement can be found here:
 * http://opcfoundation.org/License/MIT/1.00/
 * ======================================================================*/

using System;
using System.Diagnostics;
using System.Runtime.CompilerServices;

namespace Opc.Ua
{
    /// <summary>
    /// Internal helpers for <see cref="ArraySegment{T}"/>.
    /// </summary>
    internal static class ArraySegmentExtensions
    {
        /// <summary>
        /// Returns the underlying array of an <see cref="ArraySegment{T}"/>.
        /// </summary>
        /// <typeparam name="T">The element type of the segment.</typeparam>
        /// <remarks>
        /// <see cref="ArraySegment{T}.Array"/> is declared nullable in the BCL
        /// because the default <see cref="ArraySegment{T}"/> value exposes a
        /// null-array segment. All call sites in this codebase invariably
        /// create segments with a non-null array, so this helper centralizes
        /// the assertion.
        /// </remarks>
        [MethodImpl(MethodImplOptions.AggressiveInlining)]
        public static T[] GetArray<T>(this ArraySegment<T> segment)
        {
            Debug.Assert(segment.Array != null,
                "ArraySegment.Array must be non-null at this site.");
            return segment.Array!;
        }
    }
}