Skip to content

Commit 744428d

Browse files
authored
Clean up CrypoStream/GZipStream/DeflateStream docs (dotnet#9745)
1 parent 8d76fda commit 744428d

File tree

24 files changed

+798
-858
lines changed

24 files changed

+798
-858
lines changed

includes/remarks/System.IO.Compression/DeflateStream/.ctor_Stream_CompressionMode.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,4 +12,3 @@ The following example shows how to use the <xref:System.IO.Compression.DeflateSt
1212

1313
:::code language="csharp" source="~/snippets/csharp/System.IO.Compression/Deflate/FileCompressionModeExample.cs" id="Snippet1":::
1414
:::code language="vb" source="~/snippets/visualbasic/System.IO.Compression/Deflate/FileCompressionModeExample.vb" id="Snippet1":::
15-

includes/remarks/System.IO.Compression/DeflateStream/BeginRead_Byte_Int32_Int32_AsyncCallback_Object.md

Lines changed: 0 additions & 12 deletions
This file was deleted.

includes/remarks/System.IO.Compression/DeflateStream/BeginWrite_Byte_Int32_Int32_AsyncCallback_Object.md

Lines changed: 0 additions & 11 deletions
This file was deleted.

includes/remarks/System.IO.Compression/DeflateStream/DeflateStream.md

Lines changed: 0 additions & 14 deletions
This file was deleted.

includes/remarks/System.IO.Compression/GZipStream/BeginRead_Byte_Int32_Int32_AsyncCallback_Object.md

Lines changed: 0 additions & 11 deletions
This file was deleted.

includes/remarks/System.IO.Compression/GZipStream/GZipStream.md

Lines changed: 0 additions & 14 deletions
This file was deleted.

snippets/csharp/System.IO.Compression/Deflate/Deflate.csproj

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,8 @@
22

33
<PropertyGroup>
44
<OutputType>Exe</OutputType>
5-
<TargetFramework>net6.0</TargetFramework>
5+
<TargetFramework>net8.0</TargetFramework>
66
<Nullable>enable</Nullable>
7-
<StartupObject>FileCompressionModeExample</StartupObject>
87
</PropertyGroup>
98

109
</Project>

snippets/csharp/System.IO.Compression/Deflate/FileCompressionLevelExample.cs

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ public static class FileCompressionLevelExample
99
private const string OriginalFileName = "original.txt";
1010
private const string CompressedFileName = "compressed.dfl";
1111

12-
public static void Main()
12+
public static void Run()
1313
{
1414
CreateFileToCompress();
1515
CompressFile();
@@ -18,8 +18,8 @@ public static void Main()
1818

1919
/*
2020
Output:
21-
The original file 'original.txt' weighs 445 bytes.
22-
The compressed file 'compressed.dfl' weighs 259 bytes.
21+
The original file 'original.txt' is 445 bytes.
22+
The compressed file 'compressed.dfl' is 259 bytes.
2323
*/
2424
}
2525

@@ -37,9 +37,9 @@ private static void PrintResults()
3737
{
3838
long originalSize = new FileInfo(OriginalFileName).Length;
3939
long compressedSize = new FileInfo(CompressedFileName).Length;
40-
41-
Console.WriteLine($"The original file '{OriginalFileName}' weighs {originalSize} bytes.");
42-
Console.WriteLine($"The compressed file '{CompressedFileName}' weighs {compressedSize} bytes.");
40+
41+
Console.WriteLine($"The original file '{OriginalFileName}' is {originalSize} bytes.");
42+
Console.WriteLine($"The compressed file '{CompressedFileName}' is {compressedSize} bytes.");
4343
}
4444

4545
private static void DeleteFiles()

snippets/csharp/System.IO.Compression/Deflate/FileCompressionModeExample.cs

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ public static class FileCompressionModeExample
1010
private const string CompressedFileName = "compressed.dfl";
1111
private const string DecompressedFileName = "decompressed.txt";
1212

13-
public static void Main()
13+
public static void Run()
1414
{
1515
CreateFileToCompress();
1616
CompressFile();
@@ -21,11 +21,11 @@ public static void Main()
2121
/*
2222
Output:
2323
24-
The original file 'original.txt' weighs 445 bytes. Contents: "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum."
24+
The original file 'original.txt' is 445 bytes. Contents: "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum."
2525
26-
The compressed file 'compressed.dfl' weighs 265 bytes.
26+
The compressed file 'compressed.dfl' is 265 bytes.
2727
28-
The decompressed file 'decompressed.txt' weighs 445 bytes. Contents: "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum."
28+
The decompressed file 'decompressed.txt' is 445 bytes. Contents: "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum."
2929
*/
3030
}
3131

@@ -52,10 +52,10 @@ private static void PrintResults()
5252
long originalSize = new FileInfo(OriginalFileName).Length;
5353
long compressedSize = new FileInfo(CompressedFileName).Length;
5454
long decompressedSize = new FileInfo(DecompressedFileName).Length;
55-
56-
Console.WriteLine($"The original file '{OriginalFileName}' weighs {originalSize} bytes. Contents: \"{File.ReadAllText(OriginalFileName)}\"");
57-
Console.WriteLine($"The compressed file '{CompressedFileName}' weighs {compressedSize} bytes.");
58-
Console.WriteLine($"The decompressed file '{DecompressedFileName}' weighs {decompressedSize} bytes. Contents: \"{File.ReadAllText(DecompressedFileName)}\"");
55+
56+
Console.WriteLine($"The original file '{OriginalFileName}' is {originalSize} bytes. Contents: \"{File.ReadAllText(OriginalFileName)}\"");
57+
Console.WriteLine($"The compressed file '{CompressedFileName}' is {compressedSize} bytes.");
58+
Console.WriteLine($"The decompressed file '{DecompressedFileName}' is {decompressedSize} bytes. Contents: \"{File.ReadAllText(DecompressedFileName)}\"");
5959
}
6060

6161
private static void DeleteFiles()

snippets/csharp/System.IO.Compression/Deflate/MemoryWriteReadExample.cs

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ public static class MemoryWriteReadExample
99
private const string Message = "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.";
1010
private static readonly byte[] s_messageBytes = Encoding.ASCII.GetBytes(Message);
1111

12-
public static void Main()
12+
public static void Run()
1313
{
1414
Console.WriteLine($"The original string length is {s_messageBytes.Length} bytes.");
1515
using var stream = new MemoryStream();
@@ -35,10 +35,18 @@ private static int DecompressStreamToBytes(Stream stream)
3535
{
3636
stream.Position = 0;
3737
int bufferSize = 512;
38-
byte[] decompressedBytes = new byte[bufferSize];
39-
using var decompressor = new DeflateStream(stream, CompressionMode.Decompress);
40-
int length = decompressor.Read(decompressedBytes, 0, bufferSize);
41-
return length;
38+
byte[] buffer = new byte[bufferSize];
39+
using var deflateStream = new DeflateStream(stream, CompressionMode.Decompress);
40+
41+
int totalRead = 0;
42+
while (totalRead < buffer.Length)
43+
{
44+
int bytesRead = deflateStream.Read(buffer.AsSpan(totalRead));
45+
if (bytesRead == 0) break;
46+
totalRead += bytesRead;
47+
}
48+
49+
return totalRead;
4250
}
4351
}
4452
//</snippet1>
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
class Program
2+
{
3+
public static void Main()
4+
{
5+
MemoryWriteReadExample.Run();
6+
//FileCompressionLevelExample.Run();
7+
//FileCompressionModeExample.Run();
8+
}
9+
}

0 commit comments

Comments
 (0)