out ScalarValue can be null (#1716)

serilog · Jul 29, 2022 · 1c926f0 · 1c926f0
1 parent 1123784
commit 1c926f0
Show file tree

Hide file tree

Showing 5 changed files with 18 additions and 10 deletions.
diff --git a/src/Serilog/Core/IScalarConversionPolicy.cs b/src/Serilog/Core/IScalarConversionPolicy.cs
@@ -1,4 +1,6 @@
-using Serilog.Events;
+#nullable enable
+using System.Diagnostics.CodeAnalysis;
+using Serilog.Events;
 
 namespace Serilog.Core
 {
@@ -14,6 +16,6 @@ interface IScalarConversionPolicy
         /// <param name="value">The value to convert.</param>
         /// <param name="result">The converted value, or null.</param>
         /// <returns>True if the value could be converted under this policy.</returns>
-        bool TryConvertToScalar(object value, out ScalarValue result);
+        bool TryConvertToScalar(object value, [NotNullWhen(true)] out ScalarValue? result);
     }
-}
+}
diff --git a/src/Serilog/Policies/ByteArrayScalarConversionPolicy.cs b/src/Serilog/Policies/ByteArrayScalarConversionPolicy.cs
@@ -12,6 +12,8 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+#nullable enable
+using System.Diagnostics.CodeAnalysis;
 using System.Linq;
 using Serilog.Core;
 using Serilog.Events;
@@ -25,10 +27,9 @@ class ByteArrayScalarConversionPolicy : IScalarConversionPolicy
     {
         const int MaximumByteArrayLength = 1024;
 
-        public bool TryConvertToScalar(object value, out ScalarValue result)
+        public bool TryConvertToScalar(object value, [NotNullWhen(true)] out ScalarValue? result)
         {
-            var bytes = value as byte[];
-            if (bytes == null)
+            if (value is not byte[] bytes)
             {
                 result = null;
                 return false;

diff --git a/src/Serilog/Policies/ByteMemoryScalarConversionPolicy.cs b/src/Serilog/Policies/ByteMemoryScalarConversionPolicy.cs
@@ -14,8 +14,9 @@
 
 #if FEATURE_SPAN
 
+#nullable enable
 using System;
-
+using System.Diagnostics.CodeAnalysis;
 using Serilog.Core;
 using Serilog.Events;
 
@@ -29,7 +30,7 @@ sealed class ByteMemoryScalarConversionPolicy : IScalarConversionPolicy
         const int MaximumByteArrayLength = 1024;
         const int MaxTake = 16;
 
-        public bool TryConvertToScalar(object value, out ScalarValue result)
+        public bool TryConvertToScalar(object value, [NotNullWhen(true)] out ScalarValue? result)
         {
             if (value is ReadOnlyMemory<byte> x)
             {

diff --git a/src/Serilog/Policies/EnumScalarConversionPolicy.cs b/src/Serilog/Policies/EnumScalarConversionPolicy.cs
@@ -12,6 +12,8 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+#nullable enable
+using System.Diagnostics.CodeAnalysis;
 using Serilog.Core;
 using Serilog.Events;
 using System.Reflection;
@@ -20,7 +22,7 @@ namespace Serilog.Policies
 {
     class EnumScalarConversionPolicy : IScalarConversionPolicy
     {
-        public bool TryConvertToScalar(object value, out ScalarValue result)
+        public bool TryConvertToScalar(object value, [NotNullWhen(true)] out ScalarValue? result)
         {
             if (value.GetType().GetTypeInfo().IsEnum)
             {

diff --git a/src/Serilog/Policies/SimpleScalarConversionPolicy.cs b/src/Serilog/Policies/SimpleScalarConversionPolicy.cs
@@ -12,8 +12,10 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+#nullable enable
 using System;
 using System.Collections.Generic;
+using System.Diagnostics.CodeAnalysis;
 using Serilog.Core;
 using Serilog.Events;
 
@@ -28,7 +30,7 @@ public SimpleScalarConversionPolicy(IEnumerable<Type> scalarTypes)
             _scalarTypes = new(scalarTypes);
         }
 
-        public bool TryConvertToScalar(object value, out ScalarValue result)
+        public bool TryConvertToScalar(object value, [NotNullWhen(true)] out ScalarValue? result)
         {
             if (_scalarTypes.Contains(value.GetType()))
             {