< Summary

Information
Class: System.IO.Compression.Deflater
Assembly: System.IO.Compression
File(s): D:\runner\runtime\src\libraries\System.IO.Compression\src\System\IO\Compression\DeflateZLib\Deflater.cs
Line coverage
0%
Covered lines: 0
Uncovered lines: 110
Coverable lines: 110
Total lines: 208
Line coverage: 0%
Branch coverage
0%
Covered branches: 0
Total branches: 20
Branch coverage: 0%
Method coverage

Feature is only available for sponsors

Upgrade to PRO version

Metrics

MethodBranch coverage Cyclomatic complexity NPath complexity Sequence coverage
.ctor(...)100%110%
Finalize()100%110%
Dispose()100%110%
Dispose(...)0%440%
NeedsInput()100%110%
SetInput(...)100%110%
SetInput(...)100%110%
GetDeflateOutput(...)0%220%
ReadDeflateOutput(...)0%220%
Finish(...)100%110%
Flush(...)100%110%
DeallocateInputBufferHandle(...)0%220%
Deflate(...)0%880%
CreateDeflater(...)0%220%

File(s)

D:\runner\runtime\src\libraries\System.IO.Compression\src\System\IO\Compression\DeflateZLib\Deflater.cs

#LineLine coverage
 1// Licensed to the .NET Foundation under one or more agreements.
 2// The .NET Foundation licenses this file to you under the MIT license.
 3
 4using System.Buffers;
 5using System.Diagnostics;
 6
 7using ZErrorCode = System.IO.Compression.ZLibNative.ErrorCode;
 8using ZFlushCode = System.IO.Compression.ZLibNative.FlushCode;
 9
 10namespace System.IO.Compression
 11{
 12    /// <summary>
 13    /// Provides a wrapper around the ZLib compression API.
 14    /// </summary>
 15    internal sealed class Deflater : IDisposable
 16    {
 17        private readonly ZLibNative.ZLibStreamHandle _zlibStream;
 18        private MemoryHandle _inputBufferHandle;
 19        private bool _isDisposed;
 20        private const int minWindowBits = -15;  // WindowBits must be between -8..-15 to write no header, 8..15 for a
 21        private const int maxWindowBits = 31;   // zlib header, or 24..31 for a GZip header
 22
 23        // Note, DeflateStream or the deflater do not try to be thread safe.
 24        // The lock is just used to make writing to unmanaged structures atomic to make sure
 25        // that they do not get inconsistent fields that may lead to an unmanaged memory violation.
 26        // To prevent *managed* buffer corruption or other weird behavior users need to synchronize
 27        // on the stream explicitly.
 028        private object SyncLock => this;
 29
 030        private Deflater(ZLibNative.ZLibStreamHandle zlibStream)
 031        {
 032            _zlibStream = zlibStream;
 033        }
 34
 35        ~Deflater()
 036        {
 037            Dispose(false);
 038        }
 39
 40        public void Dispose()
 041        {
 042            Dispose(true);
 043            GC.SuppressFinalize(this);
 044        }
 45
 46        private void Dispose(bool disposing)
 047        {
 048            if (!_isDisposed)
 049            {
 050                if (disposing)
 051                {
 052                    _zlibStream.Dispose();
 053                }
 54
 55                // Unpin the input buffer, but avoid modifying the ZLibStreamHandle (which may have been disposed of).
 056                DeallocateInputBufferHandle(resetStreamHandle: false);
 057                _isDisposed = true;
 058            }
 059        }
 60
 061        public bool NeedsInput() => 0 == _zlibStream.AvailIn;
 62
 63        internal unsafe void SetInput(ReadOnlyMemory<byte> inputBuffer)
 064        {
 065            Debug.Assert(NeedsInput(), "We have something left in previous input!");
 066            Debug.Assert(!inputBuffer.IsEmpty);
 67
 068            lock (SyncLock)
 069            {
 070                _inputBufferHandle = inputBuffer.Pin();
 71
 072                _zlibStream.NextIn = (IntPtr)_inputBufferHandle.Pointer;
 073                _zlibStream.AvailIn = (uint)inputBuffer.Length;
 074            }
 075        }
 76
 77        internal unsafe void SetInput(byte* inputBufferPtr, int count)
 078        {
 079            Debug.Assert(NeedsInput(), "We have something left in previous input!");
 080            Debug.Assert(inputBufferPtr != null);
 081            Debug.Assert(count > 0);
 82
 083            lock (SyncLock)
 084            {
 085                _zlibStream.NextIn = (IntPtr)inputBufferPtr;
 086                _zlibStream.AvailIn = (uint)count;
 087            }
 088        }
 89
 90        internal int GetDeflateOutput(byte[] outputBuffer)
 091        {
 092            Debug.Assert(null != outputBuffer, "Can't pass in a null output buffer!");
 093            Debug.Assert(!NeedsInput(), "GetDeflateOutput should only be called after providing input");
 94
 95            try
 096            {
 97                int bytesRead;
 098                ReadDeflateOutput(outputBuffer, ZFlushCode.NoFlush, out bytesRead);
 099                return bytesRead;
 100            }
 101            finally
 0102            {
 103                // Before returning, make sure to release input buffer if necessary:
 0104                if (0 == _zlibStream.AvailIn)
 0105                {
 0106                    DeallocateInputBufferHandle(resetStreamHandle: true);
 0107                }
 0108            }
 0109        }
 110
 111        private unsafe ZErrorCode ReadDeflateOutput(byte[] outputBuffer, ZFlushCode flushCode, out int bytesRead)
 0112        {
 0113            Debug.Assert(outputBuffer?.Length > 0);
 114
 0115            lock (SyncLock)
 0116            {
 0117                fixed (byte* bufPtr = &outputBuffer[0])
 0118                {
 0119                    _zlibStream.NextOut = (IntPtr)bufPtr;
 0120                    _zlibStream.AvailOut = (uint)outputBuffer.Length;
 121
 0122                    ZErrorCode errC = Deflate(flushCode);
 0123                    bytesRead = outputBuffer.Length - (int)_zlibStream.AvailOut;
 124
 0125                    return errC;
 126                }
 127            }
 0128        }
 129
 130        internal bool Finish(byte[] outputBuffer, out int bytesRead)
 0131        {
 0132            Debug.Assert(null != outputBuffer, "Can't pass in a null output buffer!");
 0133            Debug.Assert(outputBuffer.Length > 0, "Can't pass in an empty output buffer!");
 134
 0135            ZErrorCode errC = ReadDeflateOutput(outputBuffer, ZFlushCode.Finish, out bytesRead);
 0136            return errC == ZErrorCode.StreamEnd;
 0137        }
 138
 139        /// <summary>
 140        /// Returns true if there was something to flush. Otherwise False.
 141        /// </summary>
 142        internal bool Flush(byte[] outputBuffer, out int bytesRead)
 0143        {
 0144            Debug.Assert(null != outputBuffer, "Can't pass in a null output buffer!");
 0145            Debug.Assert(outputBuffer.Length > 0, "Can't pass in an empty output buffer!");
 0146            Debug.Assert(NeedsInput(), "We have something left in previous input!");
 147
 148
 149            // Note: we require that NeedsInput() == true, i.e. that 0 == _zlibStream.AvailIn.
 150            // If there is still input left we should never be getting here; instead we
 151            // should be calling GetDeflateOutput.
 152
 0153            return ReadDeflateOutput(outputBuffer, ZFlushCode.SyncFlush, out bytesRead) == ZErrorCode.Ok;
 0154        }
 155
 156        private void DeallocateInputBufferHandle(bool resetStreamHandle)
 0157        {
 0158            lock (SyncLock)
 0159            {
 0160                if (resetStreamHandle)
 0161                {
 0162                    _zlibStream.AvailIn = 0;
 0163                    _zlibStream.NextIn = ZLibNative.ZNullPtr;
 0164                }
 165
 0166                _inputBufferHandle.Dispose();
 0167            }
 0168        }
 169
 170        private ZErrorCode Deflate(ZFlushCode flushCode)
 0171        {
 172            ZErrorCode errC;
 173            try
 0174            {
 0175                errC = _zlibStream.Deflate(flushCode);
 0176            }
 0177            catch (Exception cause)
 0178            {
 0179                throw new ZLibException(SR.ZLibErrorDLLLoadError, cause);
 180            }
 181
 0182            switch (errC)
 183            {
 184                case ZErrorCode.Ok:
 185                case ZErrorCode.StreamEnd:
 0186                    return errC;
 187
 188                case ZErrorCode.BufError:
 0189                    return errC;  // This is a recoverable error
 190
 191                case ZErrorCode.StreamError:
 0192                    throw new ZLibException(SR.ZLibErrorInconsistentStream, "deflate", (int)errC, _zlibStream.GetErrorMe
 193
 194                default:
 0195                    throw new ZLibException(SR.ZLibErrorUnexpected, "deflate", (int)errC, _zlibStream.GetErrorMessage())
 196            }
 0197        }
 198
 199        public static Deflater CreateDeflater(ZLibNative.CompressionLevel compressionLevel, ZLibNative.CompressionStrate
 0200        {
 0201            Debug.Assert(windowBits >= minWindowBits && windowBits <= maxWindowBits);
 202
 0203            ZLibNative.ZLibStreamHandle zlibStream = ZLibNative.ZLibStreamHandle.CreateForDeflate(compressionLevel, wind
 204
 0205            return new Deflater(zlibStream);
 0206        }
 207    }
 208}
Generated by: ReportGenerator 5.5.10.0
7/23/2026 - 3:40:04 PM
GitHub | reportgenerator.io

Methods/Properties

SyncLock()
.ctor(System.IO.Compression.ZLibNative/ZLibStreamHandle)
Finalize()
Dispose()
Dispose(System.Boolean)
NeedsInput()
SetInput(System.ReadOnlyMemory`1<System.Byte>)
SetInput(System.Byte*,System.Int32)
GetDeflateOutput(System.Byte[])
ReadDeflateOutput(System.Byte[],System.IO.Compression.ZLibNative/FlushCode,System.Int32&)
Finish(System.Byte[],System.Int32&)
Flush(System.Byte[],System.Int32&)
DeallocateInputBufferHandle(System.Boolean)
Deflate(System.IO.Compression.ZLibNative/FlushCode)
CreateDeflater(System.IO.Compression.ZLibNative/CompressionLevel,System.IO.Compression.ZLibNative/CompressionStrategy,System.Int32,System.Int32)