Annotate System.IO.Compression.Brotli for nullable reference types (d…

…otnet#218) * Annotate System.IO.Compression.Brotli for nullable reference types * Address PR feedback
hgdiaz · Nov 23, 2019 · 7bc6a67 · 7bc6a67
1 parent 4bc6819
commit 7bc6a67
Show file tree

Hide file tree

Showing 8 changed files with 18 additions and 8 deletions.
diff --git a/src/libraries/System.IO.Compression.Brotli/ref/System.IO.Compression.Brotli.cs b/src/libraries/System.IO.Compression.Brotli/ref/System.IO.Compression.Brotli.cs
@@ -39,8 +39,8 @@ public BrotliStream(System.IO.Stream stream, System.IO.Compression.CompressionMo
         public override bool CanWrite { get { throw null; } }
         public override long Length { get { throw null; } }
         public override long Position { get { throw null; } set { } }
-        public override System.IAsyncResult BeginRead(byte[] buffer, int offset, int count, System.AsyncCallback asyncCallback, object asyncState) { throw null; }
-        public override System.IAsyncResult BeginWrite(byte[] buffer, int offset, int count, System.AsyncCallback asyncCallback, object asyncState) { throw null; }
+        public override System.IAsyncResult BeginRead(byte[] buffer, int offset, int count, System.AsyncCallback? asyncCallback, object? asyncState) { throw null; }
+        public override System.IAsyncResult BeginWrite(byte[] buffer, int offset, int count, System.AsyncCallback? asyncCallback, object? asyncState) { throw null; }
         protected override void Dispose(bool disposing) { }
         public override System.Threading.Tasks.ValueTask DisposeAsync() { throw null; }
         public override int EndRead(System.IAsyncResult asyncResult) { throw null; }

diff --git a/src/libraries/System.IO.Compression.Brotli/ref/System.IO.Compression.Brotli.csproj b/src/libraries/System.IO.Compression.Brotli/ref/System.IO.Compression.Brotli.csproj
@@ -1,5 +1,6 @@
 <Project Sdk="Microsoft.NET.Sdk">
   <PropertyGroup>
+    <Nullable>enable</Nullable>
     <Configurations>netcoreapp-Debug;netcoreapp-Release</Configurations>
   </PropertyGroup>
   <ItemGroup>

diff --git a/src/libraries/System.IO.Compression.Brotli/src/System.IO.Compression.Brotli.csproj b/src/libraries/System.IO.Compression.Brotli/src/System.IO.Compression.Brotli.csproj
@@ -3,6 +3,7 @@
     <AssemblyName>System.IO.Compression.Brotli</AssemblyName>
     <OutputType>Library</OutputType>
     <AllowUnsafeBlocks>true</AllowUnsafeBlocks>
+    <Nullable>enable</Nullable>
     <Configurations>netcoreapp-Unix-Debug;netcoreapp-Unix-Release;netcoreapp-Windows_NT-Debug;netcoreapp-Windows_NT-Release</Configurations>
   </PropertyGroup>
   <!-- Default configurations to help VS understand the options -->

diff --git a/src/libraries/System.IO.Compression.Brotli/src/System/IO/Compression/BrotliStream.cs b/src/libraries/System.IO.Compression.Brotli/src/System/IO/Compression/BrotliStream.cs
@@ -98,14 +98,14 @@ public override async ValueTask DisposeAsync()
 
         private void ReleaseStateForDispose()
         {
-            _stream = null;
+            _stream = null!;
             _encoder.Dispose();
             _decoder.Dispose();
 
             byte[] buffer = _buffer;
             if (buffer != null)
             {
-                _buffer = null;
+                _buffer = null!;
                 if (!AsyncOperationIsActive)
                 {
                     ArrayPool<byte>.Shared.Return(buffer);

diff --git a/src/libraries/System.IO.Compression.Brotli/src/System/IO/Compression/dec/BrotliDecoder.cs b/src/libraries/System.IO.Compression.Brotli/src/System/IO/Compression/dec/BrotliDecoder.cs
@@ -3,6 +3,7 @@
 // See the LICENSE file in the project root for more information.
 
 using System.Buffers;
+using System.Diagnostics;
 using System.Runtime.InteropServices;
 using Microsoft.Win32.SafeHandles;
 using size_t = System.IntPtr;
@@ -11,7 +12,7 @@ namespace System.IO.Compression
 {
     public struct BrotliDecoder : IDisposable
     {
-        private SafeBrotliDecoderHandle _state;
+        private SafeBrotliDecoderHandle? _state;
         private bool _disposed;
 
         internal void InitializeDecoder()
@@ -43,6 +44,8 @@ private void EnsureNotDisposed()
         public OperationStatus Decompress(ReadOnlySpan<byte> source, Span<byte> destination, out int bytesConsumed, out int bytesWritten)
         {
             EnsureInitialized();
+            Debug.Assert(_state != null);
+
             bytesConsumed = 0;
             bytesWritten = 0;
             if (Interop.Brotli.BrotliDecoderIsFinished(_state))

diff --git a/...ies/System.IO.Compression.Brotli/src/System/IO/Compression/dec/BrotliStream.Decompress.cs b/...ies/System.IO.Compression.Brotli/src/System/IO/Compression/dec/BrotliStream.Decompress.cs
@@ -88,7 +88,7 @@ public override int Read(Span<byte> buffer)
             return totalWritten;
         }
 
-        public override IAsyncResult BeginRead(byte[] buffer, int offset, int count, AsyncCallback asyncCallback, object asyncState) =>
+        public override IAsyncResult BeginRead(byte[] buffer, int offset, int count, AsyncCallback? asyncCallback, object? asyncState) =>
             TaskToApm.Begin(ReadAsync(buffer, offset, count, CancellationToken.None), asyncCallback, asyncState);
 
         public override int EndRead(IAsyncResult asyncResult) =>

diff --git a/src/libraries/System.IO.Compression.Brotli/src/System/IO/Compression/enc/BrotliEncoder.cs b/src/libraries/System.IO.Compression.Brotli/src/System/IO/Compression/enc/BrotliEncoder.cs
@@ -3,6 +3,7 @@
 // See the LICENSE file in the project root for more information.
 
 using System.Buffers;
+using System.Diagnostics;
 using System.Runtime.InteropServices;
 using Microsoft.Win32.SafeHandles;
 using size_t = System.IntPtr;
@@ -11,7 +12,7 @@ namespace System.IO.Compression
 {
     public partial struct BrotliEncoder : IDisposable
     {
-        internal SafeBrotliEncoderHandle _state;
+        internal SafeBrotliEncoderHandle? _state;
         private bool _disposed;
 
         public BrotliEncoder(int quality, int window)
@@ -64,6 +65,7 @@ internal void SetQuality(int quality)
             if (_state == null || _state.IsInvalid || _state.IsClosed)
             {
                 InitializeEncoder();
+                Debug.Assert(_state != null && !_state.IsInvalid && !_state.IsClosed);
             }
             if (quality < BrotliUtils.Quality_Min || quality > BrotliUtils.Quality_Max)
             {
@@ -81,6 +83,7 @@ internal void SetWindow(int window)
             if (_state == null || _state.IsInvalid || _state.IsClosed)
             {
                 InitializeEncoder();
+                Debug.Assert(_state != null && !_state.IsInvalid && !_state.IsClosed);
             }
             if (window < BrotliUtils.WindowBits_Min || window > BrotliUtils.WindowBits_Max)
             {
@@ -119,6 +122,8 @@ public static int GetMaxCompressedLength(int inputSize)
         internal OperationStatus Compress(ReadOnlySpan<byte> source, Span<byte> destination, out int bytesConsumed, out int bytesWritten, BrotliEncoderOperation operation)
         {
             EnsureInitialized();
+            Debug.Assert(_state != null);
+
             bytesWritten = 0;
             bytesConsumed = 0;
             size_t availableOutput = (size_t)destination.Length;

diff --git a/...aries/System.IO.Compression.Brotli/src/System/IO/Compression/enc/BrotliStream.Compress.cs b/...aries/System.IO.Compression.Brotli/src/System/IO/Compression/enc/BrotliStream.Compress.cs
@@ -57,7 +57,7 @@ internal void WriteCore(ReadOnlySpan<byte> buffer, bool isFinalBlock = false)
             }
         }
 
-        public override IAsyncResult BeginWrite(byte[] buffer, int offset, int count, AsyncCallback asyncCallback, object asyncState) =>
+        public override IAsyncResult BeginWrite(byte[] buffer, int offset, int count, AsyncCallback? asyncCallback, object? asyncState) =>
             TaskToApm.Begin(WriteAsync(buffer, offset, count, CancellationToken.None), asyncCallback, asyncState);
 
         public override void EndWrite(IAsyncResult asyncResult) =>