Class BestEncodingFilter

A filter that can be used to determine the most efficient content-transfer-encoding.

Keeps track of the content that passes through the filter in order to determine the most efficient ContentEncoding to use.

Hierarchy (View Summary)

MimeFilterBase
- BestEncodingFilter

Index

Constructors

Properties

Methods

getBestEncoding filterInternal reset filter flush saveRemainingInput ensureOutputSize

Constructors

constructor

new BestEncodingFilter(): BestEncodingFilter

Returns BestEncodingFilter

Inherited from MimeFilterBase.constructor

Properties

`Protected` `Optional`outputBuffer

outputBuffer?: Uint8Array<ArrayBufferLike>

The reusable output buffer used by this filter.

Methods

getBestEncoding

getBestEncoding(
constraint: EncodingConstraint,
maxLineLength?: number,
): ContentEncoding
Get the best encoding given the specified constraints.
Parameters
- constraint: EncodingConstraint
  The encoding constraint.
- maxLineLength: number = 78
  The maximum allowable line length, not counting CRLF. Must be between 60 and 998 inclusive.
Returns ContentEncoding
The best encoding.

Throws
constraint is invalid or maxLineLength is outside the supported range.
- Defined in src/io/filters/best-encoding-filter.ts:44

`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 unmodified input range.
Overrides MimeFilterBase.filterInternal
- Defined in src/io/filters/best-encoding-filter.ts:145

reset

reset(): void
Reset the filter.

Returns void
Overrides MimeFilterBase.reset
- Defined in src/io/filters/best-encoding-filter.ts:156

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