ArchiveFormatInfo Struct

The format of an archive or a compressed stream, as detected by ArchiveFile.DetectFormat.

public readonly struct ArchiveFormatInfo : IEquatable<ArchiveFormatInfo>
Implements

Constructors

NameDescription
ArchiveFormatInfo(ArchiveFormat, CompressionFormat)The format of an archive or a compressed stream, as detected by ArchiveFile.DetectFormat.

ArchiveFormatInfo(ArchiveFormat, CompressionFormat)

The format of an archive or a compressed stream, as detected by ArchiveFile.DetectFormat.

public ArchiveFormatInfo(ArchiveFormat Format, CompressionFormat CompressionFormat)

Parameters

Format ArchiveFormat
The format of the archive, or ArchiveFormat.Unknown when the data are not an archive (a compressed file that is not a tar archive, or unknown data).
CompressionFormat CompressionFormat
The compression around the archive or the data (the gzip of a .tar.gz).

Properties

NameDescription
CompressionFormatThe compression around the archive or the data (the gzip of a .tar.gz).
FormatThe format of the archive, or ArchiveFormat.Unknown when the data are not an archive (a compressed file that is not a tar archive, or unknown data).
SupportsForwardOnlyReadingGets a value indicating whether ArchiveReader.Create can read the data (every archive format but 7z, which needs to seek).
SupportsRandomAccessGets a value indicating whether ArchiveFile.Open can open the data.

CompressionFormat

ArchiveFormatInfo.cs

The compression around the archive or the data (the gzip of a .tar.gz).

public CompressionFormat CompressionFormat { get; init; }

Property value

CompressionFormat

The format of the archive, or ArchiveFormat.Unknown when the data are not an archive (a compressed file that is not a tar archive, or unknown data).

public ArchiveFormat Format { get; init; }

Property value

ArchiveFormat

SupportsForwardOnlyReading

ArchiveFormatInfo.cs

Gets a value indicating whether ArchiveReader.Create can read the data (every archive format but 7z, which needs to seek).

public bool SupportsForwardOnlyReading { get; }

Property value

bool

SupportsRandomAccess

ArchiveFormatInfo.cs

Gets a value indicating whether ArchiveFile.Open can open the data.

public bool SupportsRandomAccess { get; }

Property value

bool

Methods

NameDescription
Deconstruct(ArchiveFormat, CompressionFormat)
Equals(ArchiveFormatInfo)
Equals(object)
GetHashCode()
ToString()

Deconstruct(ArchiveFormat, CompressionFormat)

public void Deconstruct(out ArchiveFormat Format, out CompressionFormat CompressionFormat)

Parameters

Format ArchiveFormat
CompressionFormat CompressionFormat

No documentation is available.

Equals overloads

Equals(ArchiveFormatInfo)

public bool Equals(ArchiveFormatInfo other)
Parameters
other ArchiveFormatInfo
Returns

bool

No documentation is available.

Equals(object)

public override bool Equals(object obj)
Parameters
obj object
Returns

bool

No documentation is available.

GetHashCode()

public override int GetHashCode()

Returns

int

No documentation is available.

ToString()

public override string ToString()

Returns

string

No documentation is available.

Operators

NameDescription
operator ==(ArchiveFormatInfo, ArchiveFormatInfo)
operator !=(ArchiveFormatInfo, ArchiveFormatInfo)

operator ==(ArchiveFormatInfo, ArchiveFormatInfo)

public static bool operator ==(ArchiveFormatInfo left, ArchiveFormatInfo right)

Parameters

left ArchiveFormatInfo
right ArchiveFormatInfo

Returns

bool

No documentation is available.

operator !=(ArchiveFormatInfo, ArchiveFormatInfo)

public static bool operator !=(ArchiveFormatInfo left, ArchiveFormatInfo right)

Parameters

left ArchiveFormatInfo
right ArchiveFormatInfo

Returns

bool

No documentation is available.