Interface MimeEncoder

Readonlyencoding

clone

• clone(): MimeEncoder

  Creates a new encoder with exactly the same state as this encoder.

  Returns MimeEncoder

  A new encoder with identical state.

estimateOutputLength

• estimateOutputLength(inputLength: number): number

  Estimates the number of bytes needed to encode the specified number of input bytes.

  Parameters

  • inputLength: number

    The input length.

  Returns number

  The estimated output length.

encode

• encode(
      input: Uint8Array,
      startIndex: number,
      length: number,
      output: Uint8Array,
  ): number

  Encodes the specified input into the output buffer.

  The output buffer should be large enough to hold all encoded input. Use estimateOutputLength to estimate the required size.

  Parameters

  • input: Uint8Array

    The input buffer.

  • startIndex: number

    The starting index of the input buffer.

  • length: number

    The length of the input range.

  • output: Uint8Array

    The output buffer.

  Returns number

  The number of bytes written to the output buffer.

  Throws

  The input range is invalid or the output buffer is too small.

flush

• flush(
      input: Uint8Array,
      startIndex: number,
      length: number,
      output: Uint8Array,
  ): number

  Encodes the specified input into the output buffer and flushes internal state.

  The output buffer should be large enough to hold all encoded input. Use estimateOutputLength to estimate the required size.

  Parameters

  • input: Uint8Array

    The input buffer.

  • startIndex: number

    The starting index of the input buffer.

  • length: number

    The length of the input range.

  • output: Uint8Array

    The output buffer.

  Returns number

  The number of bytes written to the output buffer.

  Throws

  The input range is invalid or the output buffer is too small.

reset

• reset(): void

  Resets the state of the encoder.

  Returns void