Class CharsetFilter

A charset filter for incrementally converting text streams from one charset encoding to another.

Hierarchy (View Summary)

MimeFilterBase
- CharsetFilter

Index

Constructors

Properties

sourceEncoding targetEncoding outputBuffer?

Methods

filterInternal reset filter flush saveRemainingInput ensureOutputSize

Constructors

constructor

new CharsetFilter(
sourceEncoding: string | number | CharsetEncoding,
targetEncoding: string | number | CharsetEncoding,
): CharsetFilter
Create a charset filter to convert text from the source encoding into the target encoding.
Parameters
- sourceEncoding: string | number | CharsetEncoding
  The source encoding name, code page, or charset encoding.
- targetEncoding: string | number | CharsetEncoding
  The target encoding name, code page, or charset encoding.
Returns CharsetFilter

Throws
An encoding is null, unsupported, or not a charset encoding.

Throws
A code page is outside the valid range.
Overrides MimeFilterBase.constructor
- Defined in src/io/filters/charset-filter.ts:71

Properties

`Readonly`sourceEncoding

sourceEncoding: CharsetEncoding

The source charset encoding.

`Readonly`targetEncoding

targetEncoding: CharsetEncoding

The target charset encoding.

`Protected` `Optional`outputBuffer

outputBuffer?: Uint8Array<ArrayBufferLike>

The reusable output buffer used by this filter.

Methods

`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 length of the input buffer, starting at startIndex.
- flush: boolean
  Whether all internally buffered data should be flushed to the output buffer.
Returns MimeFilterResult
The filtered output range.
Overrides MimeFilterBase.filterInternal
- Defined in src/io/filters/charset-filter.ts:90

reset

reset(): void
Reset the filter.

Returns void
Overrides MimeFilterBase.reset
- Defined in src/io/filters/charset-filter.ts:103

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