XzCompressionOptions Class

The options of the compression of an XzStream.

public sealed class XzCompressionOptions

Constructors

NameDescription
XzCompressionOptions()

XzCompressionOptions()

XzCompressionOptions.cs
public XzCompressionOptions()

No documentation is available.

Properties

NameDescription
BlockSizeGets or sets the number of bytes of uncompressed data of each block, or 0 to write a single block. The default is 0.
CheckGets or sets the integrity check of the blocks. The default is XzCheck.Crc64.
DictionarySizeGets or sets the dictionary size in bytes, from 4 KiB to 1.5 GiB, or null to use the one of the preset.
ExtremeGets or sets a value indicating whether to use the slower variant of the preset, which may compress better (xz --extreme).
PresetGets or sets the preset of xz, from 0 (fastest) to 9 (smallest output). The default is 6.

Gets or sets the number of bytes of uncompressed data of each block, or 0 to write a single block. The default is 0.

public long BlockSize { get; set; }

Property value

long

Exceptions

ArgumentOutOfRangeException
The value is negative.

Gets or sets the integrity check of the blocks. The default is XzCheck.Crc64.

public XzCheck Check { get; set; }

Property value

XzCheck

Exceptions

ArgumentOutOfRangeException
The value is not a member of XzCheck.

Gets or sets the dictionary size in bytes, from 4 KiB to 1.5 GiB, or null to use the one of the preset.

public int? DictionarySize { get; set; }

Property value

int?

Exceptions

ArgumentOutOfRangeException
The value is not between 4 KiB and 1.5 GiB.

Gets or sets a value indicating whether to use the slower variant of the preset, which may compress better (xz --extreme).

public bool Extreme { get; set; }

Property value

bool

Gets or sets the preset of xz, from 0 (fastest) to 9 (smallest output). The default is 6.

public int Preset { get; set; }

Property value

int

Exceptions

ArgumentOutOfRangeException
The value is not between 0 and 9.