Zero Install .NET API  2.18.2
ZeroInstall.Store.Implementations.Archives.ArchiveFileInfo Class Reference

A parameter object containing information about a requested archive extraction. More...

Inheritance diagram for ZeroInstall.Store.Implementations.Archives.ArchiveFileInfo:

Public Member Functions

 ArchiveFileInfo (string path, string mimeType)
 Creates a new archive file info object. More...
 
override string ToString ()
 Returns the archive in the form "ArchiveFileInfo: Path (MimeType, + StartOffset, SubDir) => Destination". Not safe for parsing! More...
 
bool Equals (ArchiveFileInfo? other)
 
override bool Equals (object? obj)
 
override int GetHashCode ()
 

Properties

string Path [get]
 The file to be extracted. More...
 
string MimeType [get]
 The MIME type of archive format of the file. More...
 
string? Extract [get, set]
 The name of the subdirectory in the archive to extract (with Unix-style slashes); null to extract entire archive. More...
 
string? Destination [get, set]
 The subdirectory within the implementation directory to extract this archive to; null for none. More...
 
long StartOffset [get, set]
 The number of bytes at the beginning of the file which should be ignored. More...
 
Uri? OriginalSource [get, set]
 The URL the file was originally downloaded from. More...
 

Detailed Description

A parameter object containing information about a requested archive extraction.

IImplementationStore.AddArchives

Constructor & Destructor Documentation

◆ ArchiveFileInfo()

ZeroInstall.Store.Implementations.Archives.ArchiveFileInfo.ArchiveFileInfo ( string  path,
string  mimeType 
)
inline

Creates a new archive file info object.

Parameters
pathThe file to be extracted.
mimeTypeThe MIME type of archive format of the file.

Member Function Documentation

◆ ToString()

override string ZeroInstall.Store.Implementations.Archives.ArchiveFileInfo.ToString ( )
inline

Returns the archive in the form "ArchiveFileInfo: Path (MimeType, + StartOffset, SubDir) => Destination". Not safe for parsing!

Property Documentation

◆ Destination

string? ZeroInstall.Store.Implementations.Archives.ArchiveFileInfo.Destination
getset

The subdirectory within the implementation directory to extract this archive to; null for none.

◆ Extract

string? ZeroInstall.Store.Implementations.Archives.ArchiveFileInfo.Extract
getset

The name of the subdirectory in the archive to extract (with Unix-style slashes); null to extract entire archive.

◆ MimeType

string ZeroInstall.Store.Implementations.Archives.ArchiveFileInfo.MimeType
get

The MIME type of archive format of the file.

◆ OriginalSource

Uri? ZeroInstall.Store.Implementations.Archives.ArchiveFileInfo.OriginalSource
getset

The URL the file was originally downloaded from.

This is used to provide additional information in case of an exception.

◆ Path

string ZeroInstall.Store.Implementations.Archives.ArchiveFileInfo.Path
get

The file to be extracted.

◆ StartOffset

long ZeroInstall.Store.Implementations.Archives.ArchiveFileInfo.StartOffset
getset

The number of bytes at the beginning of the file which should be ignored.


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