IDataStreamOps

Description

interface Tinman.Core.IO.Streams.IDataStreamOps

Defines common operations for IDataStream objects.

[OwnerReturn] [OwnerThis]
public method Background → (2)

Uses a background thread to prefetch data from this data stream.

If this data stream is already being prefetched in a background thread, this method may return this.

The resulting data stream does not support seeking (i.e. IDataStream.CanSeek returns false) and it will be in read-only ( ICanReadWrite.CanRead) mode.

IOException: If this stream does not support reading or if some other error has occurred, for example an I/O error while loading small data stream into memory up-front.

[OwnerReturn] [OwnerThis]
public method Buffer → (1)

Wraps this data stream in a buffered stream.

If this data stream is already buffered in memory, this method may return this.

An implementation may choose to perform optimizations, for example loading the whole stream content into memory for small amounts of data.

If both read and write operations are going to be used on the returned stream, seeking must be supported by this stream (see IDataStream.CanSeek).

[OwnerReturn] [OwnerThis]
public method ReadToEnd → ()

Reads all remaining data from this stream and disposes it.

[OwnerReturn] [OwnerThis]
public method ToFile → (1)

temporary ^opt : bool = true: If the data stream bytes must be copied to a temporary file:
true will use FileFlags.Temporary,
false will use FileFlags.Create.
Otherwise, this parameter will be ignored.
returns → IFile: The data file.

Converts this data stream into a random-access file.

It may be necessary to copy the data stream bytes to a temporary file.