// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
 
using System;
using System.Collections.Generic;
using System.Diagnostics;
using Microsoft.Extensions.Logging;
 
namespace Microsoft.Extensions.Diagnostics.Buffering;
 
/// <summary>
/// Represents a log record that has been serialized for purposes of buffering or similar.
/// </summary>
#pragma warning disable CA1815 // Override equals and operator equals on value types - not used for this struct, would be dead code
[DebuggerDisplay("Message: {FormattedMessage}, LogLevel:{LogLevel}, Timestamp: {Timestamp.ToString(FormatSpecifier)}")]
internal readonly struct SerializedLogRecord
{
    private const string FormatSpecifier = "u";
 
    /// <summary>
    /// Initializes a new instance of the <see cref="SerializedLogRecord"/> struct.
    /// </summary>
    /// <param name="logLevel">Logging severity level.</param>
    /// <param name="eventId">Event ID.</param>
    /// <param name="timestamp">The time when the log record was first created.</param>
    /// <param name="attributes">The set of name/value pairs associated with the record.</param>
    /// <param name="exceptionMessage">An exception message for this record.</param>
    /// <param name="formattedMessage">The formatted log message.</param>
    /// <param name="sizeInBytes">The approximate size in bytes of this instance.</param>
    public SerializedLogRecord(
        LogLevel logLevel,
        EventId eventId,
        DateTimeOffset timestamp,
        List<KeyValuePair<string, object?>> attributes,
        string exceptionMessage,
        string formattedMessage,
        int sizeInBytes)
    {
        LogLevel = logLevel;
        EventId = eventId;
        Timestamp = timestamp;
        Attributes = attributes;
        Exception = exceptionMessage;
        FormattedMessage = formattedMessage;
        SizeInBytes = sizeInBytes;
    }
 
    /// <summary>
    /// Gets the record's logging severity level.
    /// </summary>
    public LogLevel LogLevel { get; }
 
    /// <summary>
    /// Gets the record's event ID.
    /// </summary>
    public EventId EventId { get; }
 
    /// <summary>
    /// Gets the time when the log record was first created.
    /// </summary>
    public DateTimeOffset Timestamp { get; }
 
    /// <summary>
    /// Gets the variable set of name/value pairs associated with the record.
    /// </summary>
    public List<KeyValuePair<string, object?>> Attributes { get; }
 
    /// <summary>
    /// Gets an exception string for this record.
    /// </summary>
    public string? Exception { get; }
 
    /// <summary>
    /// Gets the formatted log message.
    /// </summary>
    public string? FormattedMessage { get; }
 
    /// <summary>
    /// Gets the approximate size of the serialized log record in bytes.
    /// </summary>
    public int SizeInBytes { get; }
}