namespace SabreTools.Serialization.Readers
{
    /// <summary>
    /// Defines how to read from Streams
    /// </summary>
    public interface IStreamReader<TModel>
    {
        /// <summary>
        /// Enable outputting debug information
        /// </summary>
        public bool Debug { get; set; }

        /// <summary>
        /// Deserialize a Stream into <typeparamref name="TModel"/>
        /// </summary>
        /// <typeparam name="T">Type of object to deserialize to</typeparam>
        /// <param name="data">Stream to parse</param>
        /// <returns>Filled object on success, null on error</returns>
        public TModel? Deserialize(System.IO.Stream? data);
    }
}