mirror of
https://github.com/adamhathcock/sharpcompress.git
synced 2026-07-21 08:25:22 +00:00
131 lines
3.8 KiB
Markdown
131 lines
3.8 KiB
Markdown
# SharpCompress Usage
|
|
|
|
## Stream Rules
|
|
|
|
When dealing with Streams, the rule should be that you don't close a stream you didn't create. This, in effect, should mean you should always put a Stream in a using block to dispose it.
|
|
|
|
However, the .NET Framework often has classes that will dispose streams by default to make things "easy" like the following:
|
|
|
|
```C#
|
|
using (var reader = new StreamReader(File.Open("foo")))
|
|
{
|
|
...
|
|
}
|
|
```
|
|
|
|
In this example, reader should get disposed. However, stream rules should say the the `FileStream` created by `File.Open` should remain open. However, the .NET Framework closes it for you by default unless you override the constructor. In general, you should be writing Stream code like this:
|
|
|
|
```C#
|
|
using (var fileStream = File.Open("foo"))
|
|
using (var reader = new StreamReader(fileStream))
|
|
{
|
|
...
|
|
}
|
|
```
|
|
|
|
To deal with the "correct" rules as well as the expectations of users, I've decided on this:
|
|
|
|
* When writing, leave streams open.
|
|
* When reading, close streams
|
|
|
|
To be explicit though, consider always using the overloads that use `ReaderOptions` or `WriterOptions` and explicitly set `LeaveStreamOpen` the way you want.
|
|
|
|
## Samples
|
|
|
|
Also, look over the tests for more thorough [examples](https://github.com/adamhathcock/sharpcompress/tree/master/tests/SharpCompress.Test)
|
|
|
|
### Create Zip Archive from all files in a directory to a file
|
|
|
|
```C#
|
|
using (var archive = ZipArchive.Create())
|
|
{
|
|
archive.AddAllFromDirectory("D:\\temp");
|
|
archive.SaveTo("C:\\temp.zip", CompressionType.Deflate);
|
|
}
|
|
```
|
|
|
|
### Create Zip Archive from all files in a directory and save in memory
|
|
|
|
```C#
|
|
var memoryStream = new MemoryStream();
|
|
using (var archive = ZipArchive.Create())
|
|
{
|
|
archive.AddAllFromDirectory("D:\\temp");
|
|
archive.SaveTo(memoryStream, new WriterOptions(CompressionType.Deflate)
|
|
{
|
|
LeaveStreamOpen = true
|
|
});
|
|
}
|
|
//reset memoryStream to be usable now
|
|
memoryStream.Position = 0;
|
|
```
|
|
|
|
### Extract all files from a Rar file to a directory using RarArchive
|
|
|
|
```C#
|
|
using (var archive = RarArchive.Open("Test.rar"))
|
|
{
|
|
foreach (var entry in archive.Entries.Where(entry => !entry.IsDirectory))
|
|
{
|
|
entry.WriteToDirectory("D:\\temp", new ExtractionOptions()
|
|
{
|
|
ExtractFullPath = true,
|
|
Overwrite = true
|
|
});
|
|
}
|
|
}
|
|
```
|
|
|
|
### Use ReaderFactory to autodetect archive type and Open the entry stream
|
|
|
|
```C#
|
|
using (Stream stream = File.OpenRead("Tar.tar.bz2"))
|
|
using (var reader = ReaderFactory.Open(stream))
|
|
{
|
|
while (reader.MoveToNextEntry())
|
|
{
|
|
if (!reader.Entry.IsDirectory)
|
|
{
|
|
Console.WriteLine(reader.Entry.Key);
|
|
reader.WriteEntryToDirectory(@"C:\temp", new ExtractionOptions()
|
|
{
|
|
ExtractFullPath = true,
|
|
Overwrite = true
|
|
});
|
|
}
|
|
}
|
|
}
|
|
```
|
|
|
|
### Use ReaderFactory to autodetect archive type and Open the entry stream
|
|
|
|
```C#
|
|
using (Stream stream = File.OpenRead("Tar.tar.bz2"))
|
|
using (var reader = ReaderFactory.Open(stream))
|
|
{
|
|
while (reader.MoveToNextEntry())
|
|
{
|
|
if (!reader.Entry.IsDirectory)
|
|
{
|
|
using (var entryStream = reader.OpenEntryStream())
|
|
{
|
|
entryStream.CopyTo(...);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
```
|
|
|
|
### Use WriterFactory to write all files from a directory in a streaming manner.
|
|
|
|
```C#
|
|
using (Stream stream = File.OpenWrite("C:\\temp.tgz"))
|
|
using (var writer = WriterFactory.Open(stream, ArchiveType.Tar, new WriterOptions(CompressionType.GZip)
|
|
{
|
|
LeaveOpenStream = true
|
|
}))
|
|
{
|
|
writer.WriteAll("D:\\temp", "*", SearchOption.AllDirectories);
|
|
}
|
|
```
|