IKVM.CoreLib.Diagnostics.JsonDiagnosticFormat Class Reference

Formats diagnostic events into a stream of JSON objects. More...

Static Public Member Functions
static void	Write (int id, DiagnosticLevel level, string message, object?[] args, Exception? exception, DiagnosticLocation location, TextWriter writer)
	Writes the given event data to the specified StringWriter.
static async ValueTask	WriteAsync (int id, DiagnosticLevel level, string message, object?[] args, Exception? exception, DiagnosticLocation location, TextWriter writer, CancellationToken cancellationToken)
	Writes the given event data to the specified StringWriter.
static void	Write< TWriter > (int id, DiagnosticLevel level, string message, object?[] args, Exception? exception, DiagnosticLocation location, ref TWriter writer, Encoding? encoding=null)
	Writes the given event data to the specified TWriter .

Detailed Description

Formats diagnostic events into a stream of JSON objects.

Definition at line 17 of file JsonDiagnosticFormat.cs.

Member Function Documentation

Write()

static void IKVM.CoreLib.Diagnostics.JsonDiagnosticFormat.Write ( int id, DiagnosticLevel level, string message, object?[] args, Exception? exception, DiagnosticLocation location, TextWriter writer )

static

Writes the given event data to the specified StringWriter.

Parameters

id
level
message
args
exception
location
writer

Definition at line 30 of file JsonDiagnosticFormat.cs.

        {
            var buffer = MemoryPool<byte>.Shared.Rent(65535);
 
            try
            {
                var wrt = new MemoryBufferWriter<byte>(buffer.Memory);
                Write(id, level, message, args, exception, location, ref wrt, writer.Encoding);
                writer.Write(writer.Encoding.GetString(buffer.Memory.Span[..wrt.WrittenCount]));
            }
            finally
            {
                buffer.Dispose();
            }
        }

Write< TWriter >()

static void IKVM.CoreLib.Diagnostics.JsonDiagnosticFormat.Write< TWriter > ( int id, DiagnosticLevel level, string message, object?[] args, Exception? exception, DiagnosticLocation location, ref TWriter writer, Encoding? encoding = null )

static

Writes the given event data to the specified TWriter .

Template Parameters

TWriter

Parameters

id
level
message
args
exception
location
writer
encoding

Exceptions

NotImplementedException

Type Constraints

TWriter

:

IBufferWriter<byte>

Definition at line 85 of file JsonDiagnosticFormat.cs.

                          : IBufferWriter<byte>
        {
            encoding ??= Encoding.UTF8;
 
            var mem = default(IMemoryOwner<byte>);
            var buf = (IBufferWriter<byte>)writer;
 
            try
            {
                // if we're not writing UTF8, stage to a temporary buffer
                if (encoding is not UTF8Encoding)
                {
                    mem = MemoryPool<byte>.Shared.Rent(65535);
                    buf = new MemoryBufferWriter<byte>(mem.Memory);
                }
 
                using var json = new Utf8JsonWriter(buf, new JsonWriterOptions() { Indented = false });
 
                try
                {
                    json.WriteStartObject();
                    json.WriteNumber("id", id);
                    json.WriteString("level", level switch
                    {
                        DiagnosticLevel.Trace => "trace",
                        DiagnosticLevel.Info => "info",
                        DiagnosticLevel.Warning => "warning",
                        DiagnosticLevel.Error => "error",
                        DiagnosticLevel.Fatal => "fatal",
                        _ => throw new NotImplementedException(),
                    });
 
                    json.WriteString("message", message);
                    json.WriteStartArray("args");
 
                    // encode each argument
                    foreach (var arg in args)
                        JsonSerializer.Serialize(json, arg, arg?.GetType() ?? typeof(object), JsonSerializerOptions.Default);
 
                    json.WriteEndArray();
 
                    if (location.Path != null ||
                        location.StartLine != 0 ||
                        location.StartColumn != 0 ||
                        location.EndLine != 0 ||
                        location.EndColumn != 0)
                    {
                        json.WriteStartObject("location");
                        json.WriteString("path", location.Path);
                        json.WriteStartArray("position");
                        json.WriteNumberValue(location.StartLine);
                        json.WriteNumberValue(location.StartColumn);
                        json.WriteNumberValue(location.EndLine);
                        json.WriteNumberValue(location.EndColumn);
                        json.WriteEndArray();
 
                        json.WriteEndObject();
                    }
 
                    json.WriteEndObject();
 
                    // ensure the JSON is flushed out
                    json.Flush();
 
                    // destination encoding is not UTF8, so convert
                    if (mem != null)
                    {
                        // decode into chars
                        var len = Encoding.UTF8.GetCharCount(mem.Memory.Span[..(int)json.BytesCommitted]);
                        using var tmp = MemoryPool<char>.Shared.Rent(len);
                        len = Encoding.UTF8.GetChars(mem.Memory.Span[..len], tmp.Memory.Span);
 
                        // reencode into target encoding
                        encoding.GetBytes(tmp.Memory.Span[..len], writer);
                    }
                }
                catch (ArgumentOutOfRangeException)
                {
                    // ignore large message
                }
            }
            finally
            {
                // dispose of the temporary buffer for non-UTF8
                mem?.Dispose();
            }
        }

WriteAsync()

static async ValueTask IKVM.CoreLib.Diagnostics.JsonDiagnosticFormat.WriteAsync ( int id, DiagnosticLevel level, string message, object?[] args, Exception? exception, DiagnosticLocation location, TextWriter writer, CancellationToken cancellationToken )

static

Writes the given event data to the specified StringWriter.

Parameters

id
level
message
args
exception
location
writer

Definition at line 56 of file JsonDiagnosticFormat.cs.

        {
            var buffer = MemoryPool<byte>.Shared.Rent(65535);
 
            try
            {
                var wrt = new MemoryBufferWriter<byte>(buffer.Memory);
                Write(id, level, message, args, exception, location, ref wrt, writer.Encoding);
                await writer.WriteAsync(writer.Encoding.GetString(buffer.Memory.Span[..wrt.WrittenCount]));
            }
            finally
            {
                buffer.Dispose();
            }
        }

---

The documentation for this class was generated from the following file:

• src/IKVM.CoreLib/Diagnostics/JsonDiagnosticFormat.cs