starred/sharpcompress
1
0
Fork 0
mirror of https://github.com/adamhathcock/sharpcompress.git synced 2026-02-04 05:25:00 +00:00
Code Issues 975 Packages Projects Releases 20 Wiki Activity

update docs

Browse Source
This commit is contained in:
Adam Hathcock
2026-01-15 13:04:09 +00:00
parent 7fbd751d27
commit bf7416753a
2 changed files with 22 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

38
docs/API.md
View File

@@ -40,17 +40,17 @@ using (var writer = WriterFactory.Open(stream, ArchiveType.Zip, CompressionType.
} }
// Specific writer // Specific writer
using (var archive = ZipArchive.Create()) using (var archive = ZipArchive.CreateArchive())
using (var archive = TarArchive.Create()) using (var archive = TarArchive.CreateArchive())
using (var archive = GZipArchive.Create()) using (var archive = GZipArchive.CreateArchive())
// With options // With options
var options = new WriterOptions(CompressionType.Deflate) var options = new WriterOptions(CompressionType.Deflate)
{ {
CompressionLevel = 9, CompressionLevel = 9,
LeaveStreamOpen = false LeaveStreamOpen = false
}; };
using (var archive = ZipArchive.Create()) using (var archive = ZipArchive.CreateArchive())
{ {
archive.SaveTo("output.zip", options); archive.SaveTo("output.zip", options);
} }
@@ -91,7 +91,7 @@ using (var archive = ZipArchive.Open("file.zip"))
} }
// Async extraction (requires IAsyncArchive) // Async extraction (requires IAsyncArchive)
using (var asyncArchive = await ZipArchive.OpenAsync("file.zip")) using (var asyncArchive = await ZipArchive.OpenAsyncArchive("file.zip"))
{ {
await asyncArchive.WriteToDirectoryAsync( await asyncArchive.WriteToDirectoryAsync(
@"C:\output", @"C:\output",
@@ -122,7 +122,7 @@ foreach (var entry in archive.Entries)
### Creating Archives ### Creating Archives
```csharp ```csharp
using (var archive = ZipArchive.Create()) using (var archive = ZipArchive.CreateArchive())
{ {
// Add file // Add file
archive.AddEntry("file.txt", @"C:\source\file.txt"); archive.AddEntry("file.txt", @"C:\source\file.txt");
@@ -172,9 +172,9 @@ using (var reader = ReaderFactory.Open(stream))
} }
} }
// Async variants (use OpenAsync to get IAsyncReader) // Async variants (use OpenAsyncReader to get IAsyncReader)
using (var stream = File.OpenRead("file.zip")) using (var stream = File.OpenRead("file.zip"))
using (var reader = await ReaderFactory.OpenAsync(stream)) using (var reader = await ReaderFactory.OpenAsyncReader(stream))
{ {
while (await reader.MoveToNextEntryAsync()) while (await reader.MoveToNextEntryAsync())
{ {
@@ -363,7 +363,7 @@ cts.CancelAfter(TimeSpan.FromMinutes(5));
try try
{ {
using (var archive = await ZipArchive.OpenAsync("archive.zip")) using (var archive = await ZipArchive.OpenAsyncArchive("archive.zip"))
{ {
await archive.WriteToDirectoryAsync( await archive.WriteToDirectoryAsync(
@"C:\output", @"C:\output",
@@ -381,23 +381,23 @@ catch (OperationCanceledException)
### Create with Custom Compression ### Create with Custom Compression
```csharp ```csharp
using (var archive = ZipArchive.Create()) using (var archive = ZipArchive.CreateArchive())
{ {
archive.AddAllFromDirectory(@"D:\source"); archive.AddAllFromDirectory(@"D:\source");
// Fastest // Fastest
archive.SaveTo("fast.zip", new WriterOptions(CompressionType.Deflate) archive.SaveTo("fast.zip", new WriterOptions(CompressionType.Deflate)
{ {
CompressionLevel = 1 CompressionLevel = 1
}); });
// Balanced (default) // Balanced (default)
archive.SaveTo("normal.zip", CompressionType.Deflate); archive.SaveTo("normal.zip", CompressionType.Deflate);
// Best compression // Best compression
archive.SaveTo("best.zip", new WriterOptions(CompressionType.Deflate) archive.SaveTo("best.zip", new WriterOptions(CompressionType.Deflate)
{ {
CompressionLevel = 9 CompressionLevel = 9
}); });
} }
``` ```
@@ -406,7 +406,7 @@ using (var archive = ZipArchive.Create())
```csharp ```csharp
using (var outputStream = new MemoryStream()) using (var outputStream = new MemoryStream())
using (var archive = ZipArchive.Create()) using (var archive = ZipArchive.CreateArchive())
{ {
// Add content from memory // Add content from memory
using (var contentStream = new MemoryStream(Encoding.UTF8.GetBytes("Hello"))) using (var contentStream = new MemoryStream(Encoding.UTF8.GetBytes("Hello")))

6
docs/USAGE.md
View File

@@ -48,7 +48,7 @@ Also, look over the tests for more thorough [examples](https://github.com/adamha
### Create Zip Archive from multiple files ### Create Zip Archive from multiple files
```C# ```C#
using(var archive = ZipArchive.Create()) using(var archive = ZipArchive.CreateArchive())
{ {
archive.AddEntry("file01.txt", "C:\\file01.txt"); archive.AddEntry("file01.txt", "C:\\file01.txt");
archive.AddEntry("file02.txt", "C:\\file02.txt"); archive.AddEntry("file02.txt", "C:\\file02.txt");
@@ -61,7 +61,7 @@ using(var archive = ZipArchive.Create())
### Create Zip Archive from all files in a directory to a file ### Create Zip Archive from all files in a directory to a file
```C# ```C#
using (var archive = ZipArchive.Create()) using (var archive = ZipArchive.CreateArchive())
{ {
archive.AddAllFromDirectory("D:\\temp"); archive.AddAllFromDirectory("D:\\temp");
archive.SaveTo("C:\\temp.zip", CompressionType.Deflate); archive.SaveTo("C:\\temp.zip", CompressionType.Deflate);
@@ -72,7 +72,7 @@ using (var archive = ZipArchive.Create())
```C# ```C#
var memoryStream = new MemoryStream(); var memoryStream = new MemoryStream();
using (var archive = ZipArchive.Create()) using (var archive = ZipArchive.CreateArchive())
{ {
archive.AddAllFromDirectory("D:\\temp"); archive.AddAllFromDirectory("D:\\temp");
archive.SaveTo(memoryStream, new WriterOptions(CompressionType.Deflate) archive.SaveTo(memoryStream, new WriterOptions(CompressionType.Deflate)