Introduce ScalarValue.Null (#1774)

Introduce ScalarValue.Null
serilog · Dec 14, 2022 · d5cecf3 · d5cecf3
1 parent 1fcdf10
commit d5cecf3
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 2 deletions.
diff --git a/src/Serilog/Capturing/DepthLimiter.cs b/src/Serilog/Capturing/DepthLimiter.cs
@@ -64,7 +64,7 @@ LogEventPropertyValue ILogEventPropertyValueFactory.CreatePropertyValue(object v
             if (depth == _maximumDestructuringDepth)
             {
                 SelfLog.WriteLine("Maximum destructuring depth reached.");
-                return new ScalarValue(null);
+                return ScalarValue.Null;
             }
 
             return null;

diff --git a/src/Serilog/Capturing/PropertyValueConverter.cs b/src/Serilog/Capturing/PropertyValueConverter.cs
@@ -120,7 +120,7 @@ LogEventPropertyValue CreatePropertyValue(object? value, bool destructureObjects
     LogEventPropertyValue CreatePropertyValue(object? value, Destructuring destructuring, int depth)
     {
         if (value == null)
-            return new ScalarValue(null);
+            return ScalarValue.Null;
 
         if (destructuring == Destructuring.Stringify)
         {

diff --git a/src/Serilog/Events/ScalarValue.cs b/src/Serilog/Events/ScalarValue.cs
@@ -19,6 +19,11 @@ namespace Serilog.Events;
 /// </summary>
 public class ScalarValue : LogEventPropertyValue
 {
+    /// <summary>
+    /// Scalar value representing <see langword="null"/>.
+    /// </summary>
+    public static ScalarValue Null { get; } = new(null);
+
     /// <summary>
     /// Construct a <see cref="ScalarValue"/> with the specified
     /// value.

diff --git a/test/Serilog.ApprovalTests/Serilog.approved.txt b/test/Serilog.ApprovalTests/Serilog.approved.txt
@@ -401,6 +401,7 @@ namespace Serilog.Events
     {
         public ScalarValue(object? value) { }
         public object? Value { get; }
+        public static Serilog.Events.ScalarValue Null { get; }
         public override bool Equals(object? obj) { }
         public override int GetHashCode() { }
         public override void Render(System.IO.TextWriter output, string? format = null, System.IFormatProvider? formatProvider = null) { }
@@ -409,6 +410,7 @@ namespace Serilog.Events
     {
         public SequenceValue(System.Collections.Generic.IEnumerable<Serilog.Events.LogEventPropertyValue> elements) { }
         public System.Collections.Generic.IReadOnlyList<Serilog.Events.LogEventPropertyValue> Elements { get; }
+        public static Serilog.Events.SequenceValue Empty { get; }
         public override void Render(System.IO.TextWriter output, string? format = null, System.IFormatProvider? formatProvider = null) { }
     }
     public class StructureValue : Serilog.Events.LogEventPropertyValue