CryptoExchange.Net/CryptoExchange.Net/Interfaces/IMessageAccessor.cs

using CryptoExchange.Net.Converters.MessageParsing;
using CryptoExchange.Net.Objects;
using System;
using System.Diagnostics.CodeAnalysis;
using System.IO;
using System.Threading.Tasks;

namespace CryptoExchange.Net.Interfaces
{
    /// <summary>
    /// Message accessor
    /// </summary>
    public interface IMessageAccessor
    {
        /// <summary>
        /// Is this a valid message
        /// </summary>
        bool IsValid { get; }
        /// <summary>
        /// Is the original data available for retrieval
        /// </summary>
        bool OriginalDataAvailable { get; }
        /// <summary>
        /// The underlying data object
        /// </summary>
        object? Underlying { get; }
        /// <summary>
        /// Clear internal data structure
        /// </summary>
        void Clear();
        /// <summary>
        /// Get the type of node
        /// </summary>
        /// <returns></returns>
        NodeType? GetNodeType();
        /// <summary>
        /// Get the type of node
        /// </summary>
        /// <param name="path">Access path</param>
        /// <returns></returns>
        NodeType? GetNodeType(MessagePath path);
        /// <summary>
        /// Get the value of a path
        /// </summary>
        /// <typeparam name="T"></typeparam>
        /// <param name="path"></param>
        /// <returns></returns>
        T? GetValue<T>(MessagePath path);
        /// <summary>
        /// Get the values of an array
        /// </summary>
        /// <typeparam name="T"></typeparam>
        /// <param name="path"></param>
        /// <returns></returns>
        T?[]? GetValues<T>(MessagePath path);
        /// <summary>
        /// Deserialize the message into this type
        /// </summary>
        /// <param name="type"></param>
        /// <param name="path"></param>
        /// <returns></returns>
#if NET5_0_OR_GREATER
        [UnconditionalSuppressMessage("AssemblyLoadTrimming", "IL2092:RequiresUnreferencedCode", Justification = "JsonSerializerOptions provided here has TypeInfoResolver set")]
        [UnconditionalSuppressMessage("AssemblyLoadTrimming", "IL2095:RequiresUnreferencedCode", Justification = "JsonSerializerOptions provided here has TypeInfoResolver set")]
#endif
        CallResult<object> Deserialize(Type type, MessagePath? path = null);
        /// <summary>
        /// Deserialize the message into this type
        /// </summary>
        /// <param name="path"></param>
        /// <returns></returns>
#if NET5_0_OR_GREATER
        [UnconditionalSuppressMessage("AssemblyLoadTrimming", "IL2092:RequiresUnreferencedCode", Justification = "JsonSerializerOptions provided here has TypeInfoResolver set")]
        [UnconditionalSuppressMessage("AssemblyLoadTrimming", "IL2095:RequiresUnreferencedCode", Justification = "JsonSerializerOptions provided here has TypeInfoResolver set")]
#endif
        CallResult<T> Deserialize<T>(MessagePath? path = null);

        /// <summary>
        /// Get the original string value
        /// </summary>
        /// <returns></returns>
        string GetOriginalString();
    }

    /// <summary>
    /// Stream message accessor
    /// </summary>
    public interface IStreamMessageAccessor : IMessageAccessor
    {
        /// <summary>
        /// Load a stream message
        /// </summary>
        /// <param name="stream"></param>
        /// <param name="bufferStream"></param>
        Task<CallResult> Read(Stream stream, bool bufferStream);
    }

    /// <summary>
    /// Byte message accessor
    /// </summary>
    public interface IByteMessageAccessor : IMessageAccessor
    {
        /// <summary>
        /// Load a data message
        /// </summary>
        /// <param name="data"></param>
        CallResult Read(ReadOnlyMemory<byte> data);
    }
}