Class XzArchive

Class XzArchive

Namespace: Aspose.Zip.Xz
Assembly: Aspose.Zip.dll (25.1.0)

Этот класс представляет файл архива xz. Используйте его для создания и извлечения архивов xz.

public class XzArchive : IArchive, IDisposable, IArchiveFileEntry

Наследование

objectXzArchive

Реализует

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) для распаковки.

Исключения

ArgumentException

source не поддерживает перемещение.

ArgumentNullException

source равно null.

XzArchive(string)

Инициализирует новый экземпляр класса Aspose.Zip.Xz.XzArchive, подготовленный для распаковки.

public XzArchive(string path)

Параметры

path string

Путь к источнику архива.

Примечания

Этот конструктор не распаковывает. См. метод Aspose.Zip.Xz.XzArchive.Extract(System.IO.Stream) для распаковки.

Исключения

ArgumentNullException

path равно null.

SecurityException

У вызывающего нет необходимых разрешений для доступа.

ArgumentException

path пуст, содержит только пробелы или содержит недопустимые символы.

UnauthorizedAccessException

Доступ к файлу path запрещен.

PathTooLongException

Указанный path, имя файла или оба превышают максимальную длину, определенную системой. Например, на платформах Windows пути должны быть меньше 248 символов, а имена файлов должны быть меньше 260 символов.

NotSupportedException

Файл по адресу path содержит двоеточие (:) в середине строки.

FileNotFoundException

Файл не найден.

DirectoryNotFoundException

Указанный путь недействителен, например, находится на неотображаемом диске.

IOException

Файл уже открыт.

Методы

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);
        }
    }
}

Исключения

InvalidOperationException

Заголовки архива и служебная информация не были прочитаны.

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"));
    }
}

Исключения

InvalidOperationException

Заголовки архива и служебная информация не были прочитаны.

SecurityException

У вызывающего нет необходимых разрешений для открытия fileInfo.

ArgumentException

Путь к файлу пуст или содержит только пробелы.

FileNotFoundException

Файл не найден.

UnauthorizedAccessException

Путь к файлу является доступным только для чтения или является директорией.

ArgumentNullException

fileInfo равно null.

DirectoryNotFoundException

Указанный путь недействителен, например, находится на неотображаемом диске.

IOException

Файл уже открыт.

Extract(string)

Извлекает архив xz в файл по указанному пути.

public FileInfo Extract(string path)

Параметры

path string

Путь к файлу, который будет хранить распакованные данные.

Возвращает

FileInfo

Экземпляр System.IO.FileInfo, содержащий извлеченные данные.

Примеры

using (FileStream xzFile = File.Open(sourceFileName, FileMode.Open))
{
    using (var archive = new XzArchive(xzFile))
    {
        archive.Extract("extracted.bin");
    }
}

Исключения

InvalidOperationException

Заголовки архива и служебная информация не были прочитаны.

ArgumentNullException

path равно null.

SecurityException

У вызывающего нет необходимых разрешений для доступа.

ArgumentException

path пуст, содержит только пробелы или содержит недопустимые символы.

UnauthorizedAccessException

Доступ к файлу path запрещен.

PathTooLongException

Указанный path, имя файла или оба превышают максимальную длину, определенную системой. Например, на платформах Windows пути должны быть меньше 248 символов, а имена файлов должны быть меньше 260 символов.

NotSupportedException

Файл по адресу path содержит двоеточие (:) в середине строки.

FileNotFoundException

Файл не найден.

DirectoryNotFoundException

Указанный путь недействителен, например, находится на неотображаемом диске.

IOException

Файл уже открыт.

ExtractToDirectory(string)

Извлекает содержимое архива в указанный каталог.

public void ExtractToDirectory(string destinationDirectory)

Параметры

destinationDirectory string

Путь к каталогу, в который будут помещены извлеченные файлы.

Примечания

Если каталог не существует, он будет создан.

Исключения

ArgumentNullException

destinationDirectory равно null.

PathTooLongException

Указанный путь, имя файла или оба превышают максимальную длину, определенную системой. Например, на платформах Windows пути должны быть меньше 248 символов, а имена файлов должны быть меньше 260 символов.

SecurityException

У вызывающего нет необходимых разрешений для доступа к существующему каталогу.

NotSupportedException

Если каталог не существует, путь содержит символ двоеточия (:) и не является частью метки диска (“C:").

ArgumentException

destinationDirectory является строкой нулевой длины, содержит только пробелы или содержит один или несколько недопустимых символов. Вы можете запросить недопустимые символы, используя метод System.IO.Path.GetInvalidPathChars. -или- путь начинается с символа двоеточия (:) или содержит только символ двоеточия (:).

IOException

Каталог, указанный в пути, является файлом. -или- Имя сети не известно.

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 должен поддерживать перемещение.

Исключения

ArgumentException

output не поддерживает перемещение.

ArgumentNullException

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");
}

Исключения

ArgumentNullException

destinationFileName равно null.

SecurityException

У вызывающего нет необходимых разрешений для доступа.

ArgumentException

destinationFileName пуст, содержит только пробелы или содержит недопустимые символы.

UnauthorizedAccessException

Доступ к файлу destinationFileName запрещен.

PathTooLongException

Указанный destinationFileName, имя файла или оба превышают максимальную длину, определенную системой. Например, на платформах Windows пути должны быть меньше 248 символов, а имена файлов должны быть меньше 260 символов.

NotSupportedException

Файл по адресу 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");
}

Исключения

ArgumentException

Поток 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");
}

Исключения

SecurityException

У вызывающего нет необходимых разрешений для открытия fileInfo.

ArgumentException

Путь к файлу пуст или содержит только пробелы.

FileNotFoundException

Файл не найден.

UnauthorizedAccessException

Путь к файлу является доступным только для чтения или является директорией.

ArgumentNullException

fileInfo равно null.

DirectoryNotFoundException

Указанный путь недействителен, например, находится на неотображаемом диске.

IOException

Файл уже открыт.

SetSource(string)

Устанавливает содержимое, которое будет сжиматься в архиве.

public void SetSource(string sourcePath)

Параметры

sourcePath string

Путь к файлу, который будет открыт как входной поток.

Примеры

using (var archive = new XzArchive()) 
{
    archive.SetSource("data.bin");
    archive.Save("archive.xz");
}

Исключения

ArgumentNullException

sourcePath равно null.

SecurityException

У вызывающего нет необходимых разрешений для доступа.

ArgumentException

sourcePath пуст, содержит только пробелы или содержит недопустимые символы.

UnauthorizedAccessException

Доступ к файлу sourcePath запрещен.

PathTooLongException

Указанный sourcePath, имя файла или оба превышают максимальную длину, определенную системой. Например, на платформах Windows пути должны быть меньше 248 символов, а имена файлов должны быть меньше 260 символов.

NotSupportedException

Файл по адресу sourcePath содержит двоеточие (:) в середине строки.

 Русский