Class RtfCompressedToRtf

A filter to decompress a compressed RTF stream.

Used to decompress a compressed RTF stream.

Hierarchy (View Summary)

MimeFilterBase
- RtfCompressedToRtf

Index

Constructors

Properties

outputBuffer? compressionMode

Accessors

Methods

filter flush saveRemainingInput ensureOutputSize filterInternal reset

Constructors

constructor

new RtfCompressedToRtf(): RtfCompressedToRtf
Creates a new RtfCompressedToRtf converter filter.

Returns RtfCompressedToRtf
Overrides MimeFilterBase.constructor
- Defined in src/tnef/rtf-compressed-to-rtf.ts:43

Properties

`Protected` `Optional`outputBuffer

outputBuffer?: Uint8Array<ArrayBufferLike>

The reusable output buffer used by this filter.

compressionMode

compressionMode: number = RtfCompressionMode.Unknown

Gets the compression mode.

At least 12 bytes from the stream must be processed before this property value will be accurate.

Accessors

isValidCrc32

get isValidCrc32(): boolean
Gets whether the CRC32 is valid.

Until all data has been processed, this property will always return false.

Returns boolean
- Defined in src/tnef/rtf-compressed-to-rtf.ts:53

Methods

filter

filter(input: Uint8Array, startIndex: number, length: number): MimeFilterResult
Filter the specified input buffer.
Parameters
- input: Uint8Array
  The input buffer.
- startIndex: number
  The starting index of the input buffer.
- length: number
  The number of bytes of input to filter.
Returns MimeFilterResult
The filtered output range.

Throws
input is not a Uint8Array.

Throws
startIndex and length do not specify a valid range in input.
Inherited from MimeFilterBase.filter
- Defined in src/io/filters/mime-filter-base.ts:71

flush

flush(input: Uint8Array, startIndex: number, length: number): MimeFilterResult
Filter the specified input buffer, flushing all internally buffered data to the output.
Parameters
- input: Uint8Array
  The input buffer.
- startIndex: number
  The starting index of the input buffer.
- length: number
  The number of bytes of input to filter.
Returns MimeFilterResult
The filtered output range.

Throws
input is not a Uint8Array.

Throws
startIndex and length do not specify a valid range in input.
Inherited from MimeFilterBase.flush
- Defined in src/io/filters/mime-filter-base.ts:90

`Protected`saveRemainingInput

saveRemainingInput(input: Uint8Array, startIndex: number, length: number): void
Save the remaining input for the next round of processing.
Parameters
- input: Uint8Array
  The input buffer.
- startIndex: number
  The starting index of the buffer to save.
- length: number
  The length of the buffer to save, starting at startIndex.
Returns void
Inherited from MimeFilterBase.saveRemainingInput
- Defined in src/io/filters/mime-filter-base.ts:113

`Protected`ensureOutputSize

ensureOutputSize(size: number, keep: boolean): Uint8Array
Ensure that the output buffer is at least the specified size.
Parameters
- size: number
  The minimum size needed.
- keep: boolean
  Whether the current output should be preserved.
Returns Uint8Array
The output buffer.
Inherited from MimeFilterBase.ensureOutputSize
- Defined in src/io/filters/mime-filter-base.ts:131

`Protected`filterInternal

filterInternal(
    input: Uint8Array,
    startIndex: number,
    length: number,
    _flush: boolean,
): MimeFilterResult
Filter the specified input buffer.
Parameters
- input: Uint8Array
  the input buffer.
- startIndex: number
  the starting index of the input buffer.
- length: number
  the number of bytes to filter.
- _flush: boolean
  whether to flush the filter.
Returns MimeFilterResult
the filtered output.
Overrides MimeFilterBase.filterInternal
- Defined in src/tnef/rtf-compressed-to-rtf.ts:66

reset

reset(): void
Reset the filter state.

Returns void
Overrides MimeFilterBase.reset
- Defined in src/tnef/rtf-compressed-to-rtf.ts:169