Class XzArchive
Namespace: Aspose.Zip.Xz
Assembly: Aspose.Zip.dll (25.1.0)
Цей клас представляє файл архіву xz. Використовуйте його для складання та витягування архівів xz.
public class XzArchive : IArchive, IDisposable, IArchiveFileEntry
Спадкування
Реалізує
IArchive, IDisposable, IArchiveFileEntry
Спадковані члени
object.GetType(), object.MemberwiseClone(), object.ToString(), object.Equals(object?), object.Equals(object?, object?), object.ReferenceEquals(object?, object?), object.GetHashCode()
Конструктори
XzArchive(XzArchiveSettings)
Ініціалізує новий екземпляр класу Aspose.Zip.Xz.XzArchive та складає архів у форматі xz.
public XzArchive(XzArchiveSettings settings = null)
Параметри
settings
XzArchiveSettings
Набір налаштувань конкретного архіву xz: розмір словника, розмір блоку, тип перевірки.
XzArchive(Stream)
Ініціалізує новий екземпляр класу Aspose.Zip.Xz.XzArchive, підготовлений для розпакування.
public XzArchive(Stream source)
Параметри
source
Stream
Джерело архіву.
Примітки
Цей конструктор не виконує розпакування. Дивіться метод Aspose.Zip.Xz.XzArchive.Extract(System.IO.Stream) для розпакування.
Виключення
source
не є доступним для пошуку.
source
є null.
XzArchive(string)
Ініціалізує новий екземпляр класу Aspose.Zip.Xz.XzArchive, підготовлений для розпакування.
public XzArchive(string path)
Параметри
path
string
Шлях до джерела архіву.
Примітки
Цей конструктор не виконує розпакування. Дивіться метод Aspose.Zip.Xz.XzArchive.Extract(System.IO.Stream) для розпакування.
Виключення
path
є null.
Викликач не має необхідних прав доступу.
path
є порожнім, містить лише пробіли або містить недопустимі символи.
Доступ до файлу path
заборонено.
Вказаний path
, ім’я файлу або обидва перевищують максимально допустиму довжину, визначену системою. Наприклад, на платформах Windows шляхи повинні бути менше 248 символів, а імена файлів - менше 260 символів.
Файл за path
містить двокрапку (:) посередині рядка.
Файл не знайдено.
Вказаний шлях є недійсним, наприклад, знаходиться на не змонтованому диску.
Файл вже відкритий.
Методи
Dispose()
Виконує визначені програмою завдання, пов’язані з звільненням, вивільненням або скиданням неуправляємих ресурсів.
public void Dispose()
Dispose(bool)
Виконує визначені програмою завдання, пов’язані з звільненням, вивільненням або скиданням неуправляємих ресурсів.
protected virtual void Dispose(bool disposing)
Параметри
disposing
bool
Чи повинні бути звільнені керовані ресурси.
Extract(Stream)
Витягує архів xz до потоку.
public void Extract(Stream destination)
Параметри
destination
Stream
Потік для зберігання розпакованих даних.
Приклади
using (FileStream xzFile = File.Open(sourceFileName, FileMode.Open))
{
using (FileStream extractedFile = File.Open(extractedFileName, FileMode.Create))
{
using (var archive = new XzArchive(xzFile))
{
archive.Extract(extractedFile);
}
}
}
Виключення
Заголовки архіву та службова інформація не були прочитані.
Extract(FileInfo)
Витягує архів xz до файлу.
public void Extract(FileInfo fileInfo)
Параметри
fileInfo
FileInfo
FileInfo для зберігання розпакованих даних.
Приклади
using (FileStream xzFile = File.Open(sourceFileName, FileMode.Open))
{
using (var archive = new XzArchive(xzFile))
{
archive.Extract(new FileInfo("extracted.bin"));
}
}
Виключення
Заголовки архіву та службова інформація не були прочитані.
Викликач не має необхідних прав доступу для відкриття fileInfo
.
Шлях до файлу є порожнім або містить лише пробіли.
Файл не знайдено.
Шлях до файлу є тільки для читання або є директорією.
fileInfo
є null.
Вказаний шлях є недійсним, наприклад, знаходиться на не змонтованому диску.
Файл вже відкритий.
Extract(string)
Витягує архів xz до файлу за вказаним шляхом.
public FileInfo Extract(string path)
Параметри
path
string
Шлях до файлу, який буде зберігати розпаковані дані.
Повертає
Екземпляр System.IO.FileInfo, що містить витягнуті дані.
Приклади
using (FileStream xzFile = File.Open(sourceFileName, FileMode.Open))
{
using (var archive = new XzArchive(xzFile))
{
archive.Extract("extracted.bin");
}
}
Виключення
Заголовки архіву та службова інформація не були прочитані.
path
є null.
Викликач не має необхідних прав доступу.
path
є порожнім, містить лише пробіли або містить недопустимі символи.
Доступ до файлу path
заборонено.
Вказаний path
, ім’я файлу або обидва перевищують максимально допустиму довжину, визначену системою. Наприклад, на платформах Windows шляхи повинні бути менше 248 символів, а імена файлів - менше 260 символів.
Файл за path
містить двокрапку (:) посередині рядка.
Файл не знайдено.
Вказаний шлях є недійсним, наприклад, знаходиться на не змонтованому диску.
Файл вже відкритий.
ExtractToDirectory(string)
Витягує вміст архіву до вказаної директорії.
public void ExtractToDirectory(string destinationDirectory)
Параметри
destinationDirectory
string
Шлях до директорії, куди будуть поміщені витягнуті файли.
Примітки
Якщо директорія не існує, вона буде створена.
Виключення
destinationDirectory
є null.
Вказаний шлях, ім’я файлу або обидва перевищують максимально допустиму довжину, визначену системою. Наприклад, на платформах Windows шляхи повинні бути менше 248 символів, а імена файлів - менше 260 символів.
Викликач не має необхідних прав доступу до існуючої директорії.
Якщо директорія не існує, шлях містить символ двокрапки (:) який не є частиною мітки диска (“C:").
destinationDirectory
є рядком нульової довжини, містить лише пробіли або містить один або кілька недопустимих символів. Ви можете запитати недопустимі символи, використовуючи метод System.IO.Path.GetInvalidPathChars.
-або- шлях починається з, або містить лише символ двокрапки (:).
Директорія, вказана за шляхом, є файлом. -або- Ім’я мережі невідоме.
Save(Stream)
Зберігає архів xz у наданому потоці.
public void Save(Stream output)
Параметри
output
Stream
Потік призначення.
Приклади
using (FileStream xzFile = File.Open("archive.xz", FileMode.Create))
{
using (var archive = new XzArchive())
{
archive.SetSource("data.bin");
archive.Save(xzFile);
}
}
Примітки
output
повинен бути доступним для пошуку.
Виключення
output
не підтримує пошук.
output
є null.
Save(string)
Зберігає архів xz у наданому файлі призначення.
public void Save(string destinationFileName)
Параметри
destinationFileName
string
Шлях до архіву, який потрібно створити. Якщо вказане ім’я файлу вказує на існуючий файл, він буде перезаписаний.
Приклади
using (var archive = new XzArchive())
{
archive.SetSource(new FileInfo("data.bin"));
archive.Save("result.xz");
}
Виключення
destinationFileName
є null.
Викликач не має необхідних прав доступу.
destinationFileName
є порожнім, містить лише пробіли або містить недопустимі символи.
Доступ до файлу destinationFileName
заборонено.
Вказаний destinationFileName
, ім’я файлу або обидва перевищують максимально допустиму довжину, визначену системою. Наприклад, на платформах Windows шляхи повинні бути менше 248 символів, а імена файлів - менше 260 символів.
Файл за destinationFileName
містить двокрапку (:) посередині рядка.
SetSource(Stream)
Встановлює вміст, який буде стиснутий в архіві.
public void SetSource(Stream source)
Параметри
source
Stream
Вхідний потік для архіву.
Приклади
using (var archive = new XzArchive())
{
archive.SetSource(new MemoryStream(new byte[] { 0x00, 0xFF }));
archive.Save("archive.xz");
}
Виключення
Потік source
є недоступним для пошуку.
SetSource(FileInfo)
Встановлює вміст, який буде стиснутий в архіві.
public void SetSource(FileInfo fileInfo)
Параметри
fileInfo
FileInfo
FileInfo, який буде відкрито як вхідний потік.
Приклади
using (var archive = new XzArchive())
{
archive.SetSource(new FileInfo("data.bin"));
archive.Save("archive.xz");
}
Виключення
Викликач не має необхідних прав доступу для відкриття fileInfo
.
Шлях до файлу є порожнім або містить лише пробіли.
Файл не знайдено.
Шлях до файлу є лише для читання або є директорією.
fileInfo
є null.
Вказаний шлях є недійсним, наприклад, знаходиться на не змонтованому диску.
Файл вже відкритий.
SetSource(string)
Встановлює вміст, який буде стиснутий в архіві.
public void SetSource(string sourcePath)
Параметри
sourcePath
string
Шлях до файлу, який буде відкрито як вхідний потік.
Приклади
using (var archive = new XzArchive())
{
archive.SetSource("data.bin");
archive.Save("archive.xz");
}
Виключення
sourcePath
є null.
Викликач не має необхідних прав доступу.
sourcePath
є порожнім, містить лише пробіли або містить недопустимі символи.
Доступ до файлу sourcePath
заборонено.
Вказаний sourcePath
, ім’я файлу або обидва перевищують максимально допустиму довжину, визначену системою. Наприклад, на платформах Windows шляхи повинні бути менше 248 символів, а імена файлів - менше 260 символів.
Файл за sourcePath
містить двокрапку (:) посередині рядка.