Class TnefReaderStream

A stream for reading raw values from a TnefReader or property reader.

Hierarchy (View Summary)

Stream
- TnefReaderStream

Index

Constructors

constructor

new TnefReaderStream(
    reader: TnefReader,
    dataEndOffset: number,
    valueEndOffset: number,
): TnefReaderStream
Creates a stream for reading a raw value from the TNEF reader.
Parameters
- reader: TnefReader
  the TNEF reader.
- dataEndOffset: number
  the end offset of the data.
- valueEndOffset: number
  the end offset of the container value.
Returns TnefReaderStream
Overrides Stream.constructor
- Defined in src/tnef/tnef-reader-stream.ts:17

Accessors

canRead

get canRead(): boolean
Gets whether the stream supports reading.

Returns boolean
Overrides Stream.canRead
- Defined in src/tnef/tnef-reader-stream.ts:28

canWrite

get canWrite(): boolean
Gets whether the stream supports writing.

Returns boolean
Overrides Stream.canWrite
- Defined in src/tnef/tnef-reader-stream.ts:32

canSeek

get canSeek(): boolean
Gets whether the stream supports seeking.

Returns boolean
Overrides Stream.canSeek
- Defined in src/tnef/tnef-reader-stream.ts:36

length

get length(): number
Gets the length of the stream.

Returns number

Throws
seeking is not supported.
Overrides Stream.length
- Defined in src/tnef/tnef-reader-stream.ts:42

position

get position(): number
Gets the current position within the stream.

Returns number

Throws
seeking is not supported.
Overrides Stream.position
- Defined in src/tnef/tnef-reader-stream.ts:48
set position(_value: number): void
Sets the current position within the stream.
Parameters
- _value: number
Returns void

Throws
seeking is not supported.
Overrides Stream.position
- Defined in src/tnef/tnef-reader-stream.ts:54

Methods

copyTo

copyTo(destination: Stream, bufferSize?: number): void
Copy data from this stream to another stream.
Parameters
- destination: Stream
  The stream that will receive the copied data.
- bufferSize: number = 4096
  The temporary buffer size to use while copying.
Returns void
Inherited from Stream.copyTo
- Defined in src/io/stream.ts:70

`Protected` `Static`validateBufferArguments

validateBufferArguments(buffer: Uint8Array, offset: number, count: number): void
Validate buffer, offset, and count arguments for stream read/write operations.
Parameters
- buffer: Uint8Array
  The buffer supplied by the caller.
- offset: number
  The starting offset in the buffer.
- count: number
  The number of bytes to read or write.
Returns void

Throws
offset or count does not specify a valid range in buffer.
Inherited from Stream.validateBufferArguments
- Defined in src/io/stream.ts:88

`Protected`throwNotSupported

throwNotSupported(operation: string): never
Throw for an unsupported stream operation.
Parameters
- operation: string
  The unsupported operation name.
Returns never

Throws
Always thrown because the operation is unsupported.
Inherited from Stream.throwNotSupported
- Defined in src/io/stream.ts:101

read

read(buffer: Uint8Array, offset: number, count: number): number
Read a sequence of bytes from the stream and advance the position by the number of bytes read.
Parameters
- buffer: Uint8Array
  the buffer to read data into.
- offset: number
  the offset into the buffer to start reading data.
- count: number
  the number of bytes to read.
Returns number
the number of bytes read into the buffer.

Throws
offset or count is out of range.

Throws
the stream has been disposed.
Overrides Stream.read
- Defined in src/tnef/tnef-reader-stream.ts:67

write

write(_buffer: Uint8Array, _offset: number, _count: number): void
Write a sequence of bytes to the stream.
Parameters
- _buffer: Uint8Array
- _offset: number
- _count: number
Returns void

Throws
writing is not supported.
Overrides Stream.write
- Defined in src/tnef/tnef-reader-stream.ts:83

seek

seek(_offset: number, _origin: "end" | "begin" | "current"): number
Set the position within the current stream.
Parameters
- _offset: number
- _origin: "end" | "begin" | "current"
Returns number

Throws
seeking is not supported.
Overrides Stream.seek
- Defined in src/tnef/tnef-reader-stream.ts:89

flush

flush(): void
Clear all buffers for this stream.

Returns void

Throws
writing is not supported.
Overrides Stream.flush
- Defined in src/tnef/tnef-reader-stream.ts:95

setLength

setLength(_value: number): void
Set the length of the stream.
Parameters
- _value: number
Returns void

Throws
setting the length is not supported.
Overrides Stream.setLength
- Defined in src/tnef/tnef-reader-stream.ts:101

dispose

dispose(): void
Dispose this stream.

The underlying TnefReader is not disposed.

Returns void
Overrides Stream.dispose
- Defined in src/tnef/tnef-reader-stream.ts:107

Class TnefReaderStream

Hierarchy (View Summary)

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns TnefReaderStream

Accessors

canRead

Returns boolean

canWrite

Returns boolean

canSeek

Returns boolean

length

Returns number

Throws

position

Returns number

Throws

Parameters

Returns void

Throws

Methods

copyTo

Parameters

Returns void

Protected StaticvalidateBufferArguments

Parameters

Returns void

Throws

ProtectedthrowNotSupported

Parameters

Returns never

Throws

read

Parameters

Returns number

Throws

Throws

write

Parameters

Returns void

Throws

seek

Parameters

Returns number

Throws

flush

Returns void

Throws

setLength

Parameters

Returns void

Throws

dispose

Returns void

Settings

On This Page

`Protected` `Static`validateBufferArguments

`Protected`throwNotSupported