Zero Install .NET API 2.20.0
ZeroInstall.Archives.Extractors.CabExtractor Class Reference

Extracts MS Cabinets (.cab). More...

Inheritance diagram for ZeroInstall.Archives.Extractors.CabExtractor:
ZeroInstall.Archives.Extractors.ArchiveExtractor ZeroInstall.Archives.Extractors.IArchiveExtractor

Public Member Functions

 CabExtractor (ITaskHandler handler)
 Creates a CAB extractor. More...
 
override void Extract (IBuilder builder, Stream stream, string? subDir=null)
 Extracts an archive. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from ZeroInstall.Archives.Extractors.ArchiveExtractor
static void Register (string mimeType, Func< ITaskHandler, IArchiveExtractor > factory)
 Registers an additional IArchiveExtractor. More...
 
static IArchiveExtractor For (string mimeType, ITaskHandler handler)
 Creates a new IArchiveExtractor for a specific type of archive. More...
 
- Protected Member Functions inherited from ZeroInstall.Archives.Extractors.ArchiveExtractor
void EnsureSeekable (Stream stream, [InstantHandle] Action< Stream > callback)
 Ensures that a Stream is fully seekable, creating a temporary on-disk copy if necessary. More...
 
- Static Protected Member Functions inherited from ZeroInstall.Archives.Extractors.ArchiveExtractor
static void EnsureFile (Stream stream, [InstantHandle] Action< string > callback)
 Ensures that a Stream represents an on-disk file, creating a temporary on-disk copy if necessary. More...
 
static ? string NormalizePath (string path, string? subDir)
 Normalizes the path of an archive entry. More...
 
- Protected Attributes inherited from ZeroInstall.Archives.Extractors.ArchiveExtractor
readonly ITaskHandler Handler
 A callback object used when the the user needs to be informed about IO tasks.
 
- Properties inherited from ZeroInstall.Archives.Extractors.ArchiveExtractor
object? Tag [getset]
 
- Properties inherited from ZeroInstall.Archives.Extractors.IArchiveExtractor
object? Tag [getset]
 A ITask.Tag to set for see cref="ITask"/>s spawned by this extractor; can be null.
 

Detailed Description

Extracts MS Cabinets (.cab).

This class is immutable and thread-safe.

Constructor & Destructor Documentation

◆ CabExtractor()

ZeroInstall.Archives.Extractors.CabExtractor.CabExtractor ( ITaskHandler  handler)
inline

Creates a CAB extractor.

Parameters
handlerA callback object used when the the user needs to be informed about IO tasks.
Exceptions
NotSupportedExceptionExtracting this archive type is only supported on Windows.

Member Function Documentation

◆ Extract()

override void ZeroInstall.Archives.Extractors.CabExtractor.Extract ( IBuilder  builder,
Stream  stream,
string?  subDir = null 
)
inlinevirtual

Extracts an archive.

Implements ZeroInstall.Archives.Extractors.ArchiveExtractor.


The documentation for this class was generated from the following file: