ClassBlockTransformBase
Base class for all block transformations.
Definition
Namespace:Telerik.Windows.Zip
Assembly:Telerik.Windows.Zip.dll
Syntax:
public abstract class BlockTransformBase : IBlockTransform, IDisposableInheritance: objectBlockTransformBase
Implements:
Constructors
BlockTransformBase()
Initializes a new instance of the BlockTransformBase class.
Declaration
protected BlockTransformBase()Properties
CanReuseTransform
Gets a value indicating whether the current transform can be reused.
Declaration
public abstract bool CanReuseTransform { get; }Property Value
true if the current transform can be reused; otherwise, false.
Implements
CanTransformMultipleBlocks
Gets a value indicating whether multiple blocks can be transformed.
Declaration
public abstract bool CanTransformMultipleBlocks { get; }Property Value
true if multiple blocks can be transformed; otherwise, false.
Implements
FixedInputBlockSize
Gets or sets value which indicates whether the transformation uses input buffer of the fixed size.
Footer
Gets transformation footer (if required).
Declaration
public TransformationFooter Footer { get; }Property Value
Implements
Header
Gets transformation header (if required).
Declaration
public TransformationHeader Header { get; }Property Value
Implements
InputBlockSize
Gets the input block size.
Declaration
public abstract int InputBlockSize { get; }Property Value
The size of the input data blocks in bytes.
Implements
OutputBlockSize
Gets the output block size.
Declaration
public abstract int OutputBlockSize { get; }Property Value
The size of the output data blocks in bytes.
Implements
Methods
CreateHeader(CompressionSettings)
Creates transformation header to be written into the output stream.
Declaration
public virtual void CreateHeader(CompressionSettings compressionSettings = null)Parameters
compressionSettings
Implements
Dispose()
Releases the resources used by the current instance of the ZipArchive class.
Declaration
public void Dispose()Implements
Dispose(bool)
Releases the unmanaged resources used by the transform and optionally releases the managed resources.
Declaration
protected abstract void Dispose(bool disposing)Parameters
disposing
Value which indicates whether both managed and unmanaged resources (true) on only unmanaged resources (false) should be released.
InitFooterReading(int)
Initialize reading of the transformation footer.
Declaration
public virtual void InitFooterReading(int compressedSize)Parameters
compressedSize
Implements
InitHeaderReading(CompressionSettings)
Initialize reading of the transformation header.
Declaration
public virtual void InitHeaderReading(CompressionSettings settings = null)Parameters
settings
Implements
ProcessFooter()
Process transformation footer has been read.
Declaration
public virtual void ProcessFooter()Implements
ProcessHeader()
Process transformation header has been read.
Declaration
public virtual void ProcessHeader()Implements
TransformBlock(byte[], int, int, byte[], int)
Transforms the specified region of the input byte array and copies the resulting transform to the specified region of the output byte array.
Declaration
public abstract int TransformBlock(byte[] inputBuffer, int inputOffset, int inputCount, byte[] outputBuffer, int outputOffset)Parameters
inputBuffer
byte[]
The input for which to compute the transform.
inputOffset
The offset into the input byte array from which to begin using data.
inputCount
The number of bytes in the input byte array to use as data.
outputBuffer
byte[]
The output to which to write the transform.
outputOffset
The offset into the output byte array from which to begin writing data.
Returns
The number of bytes written.
Implements
TransformFinalBlock(byte[], int, int)
Transforms the specified region of the specified byte array.
Declaration
public abstract byte[] TransformFinalBlock(byte[] inputBuffer, int inputOffset, int inputCount)Parameters
inputBuffer
byte[]
The input for which to compute the transform.
inputOffset
The offset into the byte array from which to begin using data.
inputCount
The number of bytes in the byte array to use as data.
Returns
byte[]
The computed transform.
Implements
TransformFinalBlock(byte[], int, int, CancellationToken)
Transforms the specified region of the specified byte array.
Declaration
public abstract byte[] TransformFinalBlock(byte[] inputBuffer, int inputOffset, int inputCount, CancellationToken cancellationToken)Parameters
inputBuffer
byte[]
The input for which to compute the transform.
inputOffset
The offset into the byte array from which to begin using data.
inputCount
The number of bytes in the byte array to use as data.
cancellationToken
The token to monitor for cancellation requests.
Returns
byte[]
The computed transform.
Implements
ValidateInputBufferParameters(byte[], int, int, bool, bool)
Validates parameters of the input buffer.
Declaration
protected void ValidateInputBufferParameters(byte[] inputBuffer, int inputOffset, int inputCount, bool validateBlockSize, bool allowZeroCount)Parameters
inputBuffer
byte[]
The input for which to compute the transform.
inputOffset
The offset into the input byte array from which to begin using data.
inputCount
The number of bytes in the input byte array to use as data.
validateBlockSize
Indicates whether buffer block size should be validated. Should be true for the TransformBlock and false for the TransformFinalBlock.
allowZeroCount
Indicates whether count can be zero.
ValidateParameters(byte[], int, int, byte[], int, bool)
Validates parameters of the transform operation.
Declaration
protected void ValidateParameters(byte[] inputBuffer, int inputOffset, int inputCount, byte[] outputBuffer, int outputOffset, bool allowZeroCount)Parameters
inputBuffer
byte[]
The input for which to compute the transform.
inputOffset
The offset into the input byte array from which to begin using data.
inputCount
The number of bytes in the input byte array to use as data.
outputBuffer
byte[]
The output to which to write the transform.
outputOffset
The offset into the output byte array from which to begin writing data.
allowZeroCount
Indicates whether input count can be zero.