Abstract implementation of the IDataStream interface.
abstract class
|
DataStreamBase
|
extends
|
Disposable
|
||
implements
|
IDataStream
|
||||
base of
|
BufferDataStreamBase
|
||||
MemoryDataStream
|
|||||
ReadonlyDataStreamBase
|
|||||
WriteonlyDataStreamBase
|
Does this object support read access?
public
abstract
property
|
CanRead
{
get
}
|
||
type
|
bool
|
||
value
|
true
if
this
object
supports
reading,
false
if
not. |
||
implements
|
ICanReadWrite.CanRead
|
Does this stream support seeking (via Position)?
public
abstract
property
|
CanSeek
{
get
}
|
||
type
|
bool
|
||
value
|
true
if
this
stream
supports
seeking,
false
if
not. |
||
implements
|
IDataStream.CanSeek
|
Does this binary object support write access?
public
abstract
property
|
CanWrite
{
get
}
|
||
type
|
bool
|
||
value
|
true
if
this
object
supports
writing,
false
if
not. |
||
implements
|
ICanReadWrite.CanWrite
|
The byte-order to use for reading and writing multibyte values.
public
property
|
Endianess
{
get
set
}
|
||
type
|
ByteOrder
|
||
value
|
The byte-order to use. | ||
implements
|
IDataStream.Endianess
|
Remarks:
The default byte-order is LittleEndian.
Has writing to this data stream finished?
public
property
|
IsFinished
{
get
}
|
||
type
|
bool
|
||
value
|
true
if
the
data
stream
writes
have
finished,
false
if
not. |
||
implements
|
IDataStream.IsFinished
|
See also:
IDataStream.FinishLength of this data stream.
public
abstract
property
|
Length
{
get
}
|
||
type
|
int64
|
||
value
|
|
The
length
of
this
data
stream.
If
the
length
is
unknown
resp.
the
stream
does
not
support
seeking
(see
CanSeek),
0
is
returned.
|
|
implements
|
IDataStream.Length
|
Returns the lifecycle state of this object.
public
virtual
property
|
LifecycleState
{
get
}
|
||
type
|
LifecycleState
|
||
value
|
The lifecycle state. | ||
inherited
|
Disposable.LifecycleState
|
Returns a Path object that represents the file path this object is associated with.
public
abstract
property
|
PathInfo
{
get
}
|
||
type
|
Path
|
||
value
|
|
The path info. | |
implements
|
IPathInfo.PathInfo
|
Remarks:
Objects that do not have a meaningful file path association simply return Unknown.
The current position of the file cursor.
public
abstract
property
|
Position
{
get
set
}
|
||
type
|
int64
|
||
value
|
|
The file cursor position, as an absolute offset from the beginning of the file, in bytes. | |
implements
|
IDataStream.Position
|
Exceptions:
false
.Acquires a strong reference to this disposable object.
[OwnerReturn, ThreadSafe]
|
||||
public
method
|
AcquireTry
()
|
|||
type
|
IDisposable
|
|||
returns
|
this
if
a
new
strong
reference
has
been
acquired,
null
if
this
object
is
already
being
disposed.
|
|||
inherited
|
Disposable.AcquireTry
|
Remarks:
The object will not be actually disposed by calls to Dispose when there is at least one strong reference left. Code that calls the AcquireTry method is responsible for calling the Dispose method accordingly.
This method is not intended to be used in performance-critical code. It should only be used to high-level resource management.
Uses a background thread to prefetch data from this data stream.
[OwnerReturn, OwnerThis]
|
||||
public
virtual
method
|
Background
(int32 bufferSize = 65536,
int32 bufferCount = 16)
|
|||
type
|
IDataStream
|
|||
params
|
bufferSize
|
[>0]
|
The
buffer
size,
in
bytes.
Defaults
to
65536 . |
|
bufferCount
|
[>0]
|
The
buffer
count.
Defaults
to
16 . |
||
returns
|
|
The sequential read-only data stream. | ||
implements
|
IDataStreamOps.Background
|
Remarks:
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.
CanSeek
returns
false
)
and
it
will
be
in
read-only
(
CanRead)
mode.
Wraps this data stream in a buffered stream.
[OwnerReturn, OwnerThis]
|
||||
public
virtual
method
|
Buffer
(int32 bufferSize = 65536)
|
|||
type
|
IDataStream
|
|||
params
|
bufferSize
|
[>0]
|
The
buffer
size,
in
bytes.
Defaults
to
65536 . |
|
returns
|
|
The buffered data stream. | ||
implements
|
IDataStreamOps.Buffer
|
Remarks:
If
this
data
stream
is
already
buffered
in
memory,
this
method
may
return
this
.
If both read and write operations are going to be used on the returned stream, seeking must be supported by this stream (see CanSeek).
Copies all remaining data in the given object to this object.
public
virtual
method
|
CopyFrom
(IDataStream stream)
|
||
params
|
stream
|
[not-null]
|
The object. |
implements
|
ICopyable.CopyFrom
|
Copies all remaining data in this object to the given object.
public
virtual
method
|
CopyTo
(IDataStream stream)
|
||
params
|
stream
|
[not-null]
|
The object. |
implements
|
ICopyable.CopyTo
|
Releases all resources held by this object if there are no more strong references to it, decrements the reference counter by one otherwise.
[Dispose, OwnerThis, ThreadSafe]
|
||||
public
method
|
Dispose
()
|
|||
inherited
|
Disposable.Dispose
|
Remarks:
The Dispose method silently returns if the object has already been disposed.
Flushes the data stream and tells it that no more data will be written to it.
public
method
|
Finish
()
|
||
implements
|
IDataStream.Finish
|
Flushes all cached data.
public
virtual
method
|
Flush
()
|
||
implements
|
IFlushable.Flush
|
Remarks:
Performing a flush may result in I/O work. Depending on the semantics of the implementing class, this work may need to be wrapped in special Begin / End method calls. See the documentation of the implementing classes for details.
In case this object represents a read-only resource, calling the Flush method has no effect.
Pops the topmost position from the stack and sets the current file cursor position to that value.
public
method
|
PopPosition
()
|
||
implements
|
IDataStream.PopPosition
|
Remarks:
The PushPosition and PopPosition are convenience methods that can be used jump back and forth in the file for reading/writing disjoint blocks of data.
Exceptions:
false
.Pushes the current file cursor position onto the stack.
public
method
|
PushPosition
()
|
||
implements
|
IDataStream.PushPosition
|
Remarks:
The PushPosition and PopPosition are convenience methods that can be used jump back and forth in the file for reading/writing disjoint blocks of data.
Exceptions:
false
.Reads a number of bytes from the stream.
public
abstract
method
|
Read
(ByteBuffer bytes)
|
||
type
|
int32
|
||
params
|
bytes
|
[not-null]
|
The buffer where the read bytes will be stored. |
returns
|
|
The number of bytes the have been read. | |
implements
|
IBinaryReader.Read
|
Remarks:
The number of bytes that are read from the stream may be less than the number of Remaining bytes in the given ByteBuffer, for any arbitrary reason.
Exceptions:
Reads a number of bytes from the stream.
public
method
|
ReadAll
(ByteBuffer bytes)
|
||
params
|
bytes
|
[not-null]
|
The buffer where the read bytes will be stored. |
implements
|
IBinaryReader.ReadAll
|
Remarks:
The number of bytes that are read from the stream will be equal to the number of Remaining bytes in the given ByteBuffer.
Exceptions:
Reads a 32-bit floating point value from the data stream.
public
method
|
ReadFloat32
()
|
||
type
|
float32
|
||
returns
|
The read value. | ||
implements
|
IBinaryReader.ReadFloat32
|
Exceptions:
Reads 32-bit floating point values from the data stream.
public
virtual
method
|
ReadFloat32s
(float32[] array,
int32 offset,
int32 count)
|
||
params
|
array
|
[not-null]
|
The output array. |
offset
|
[>=0]
|
Index of first array element to write. | |
count
|
[>=0]
|
Number of values to read. | |
returns
|
The read value. | ||
implements
|
IBinaryReader.ReadFloat32s
|
Exceptions:
Reads a 64-bit floating point value from the data stream.
public
method
|
ReadFloat64
()
|
||
type
|
float64
|
||
returns
|
The read value. | ||
implements
|
IBinaryReader.ReadFloat64
|
Exceptions:
Reads 64-bit floating point values from the data stream.
public
method
|
ReadFloat64s
(float64[] array,
int32 offset,
int32 count)
|
||
params
|
array
|
[not-null]
|
The output array. |
offset
|
[>=0]
|
Index of first array element to write. | |
count
|
[>=0]
|
Number of values to read. | |
returns
|
The read value. | ||
implements
|
IBinaryReader.ReadFloat64s
|
Exceptions:
Reads a signed 16-bit integer value from the data stream using.
public
virtual
method
|
ReadInt16
()
|
||
type
|
int16
|
||
returns
|
The read value. | ||
implements
|
IBinaryReader.ReadInt16
|
Exceptions:
Reads signed 16-bit integer value values from the data stream.
public
method
|
ReadInt16s
(int16[] array,
int32 offset,
int32 count)
|
||
params
|
array
|
[not-null]
|
The output array. |
offset
|
[>=0]
|
Index of first array element to write. | |
count
|
[>=0]
|
Number of values to read. | |
returns
|
The read value. | ||
implements
|
IBinaryReader.ReadInt16s
|
Exceptions:
Reads a signed 32-bit integer value from the data stream.
public
virtual
method
|
ReadInt32
()
|
||
type
|
int32
|
||
returns
|
The read value. | ||
implements
|
IBinaryReader.ReadInt32
|
Exceptions:
Reads signed 32-bit integer value values from the data stream.
public
method
|
ReadInt32s
(int32[] array,
int32 offset,
int32 count)
|
||
params
|
array
|
[not-null]
|
The output array. |
offset
|
[>=0]
|
Index of first array element to write. | |
count
|
[>=0]
|
Number of values to read. | |
returns
|
The read value. | ||
implements
|
IBinaryReader.ReadInt32s
|
Exceptions:
Reads a signed 64-bit integer value from the data stream.
public
virtual
method
|
ReadInt64
()
|
||
type
|
int64
|
||
returns
|
The read value. | ||
implements
|
IBinaryReader.ReadInt64
|
Exceptions:
Reads signed 64-bit integer value values from the data stream.
public
method
|
ReadInt64s
(int64[] array,
int32 offset,
int32 count)
|
||
params
|
array
|
[not-null]
|
The output array. |
offset
|
[>=0]
|
Index of first array element to write. | |
count
|
[>=0]
|
Number of values to read. | |
returns
|
The read value. | ||
implements
|
IBinaryReader.ReadInt64s
|
Exceptions:
Reads an 8-bit value from the stream.
public
virtual
method
|
ReadInt8
()
|
||
type
|
int8
|
||
returns
|
The read value. | ||
implements
|
IBinaryReader.ReadInt8
|
Exceptions:
Reads signed 8-bit integer value values from the data stream.
public
method
|
ReadInt8s
(int8[] array,
int32 offset,
int32 count)
|
||
params
|
array
|
[not-null]
|
The output array. |
offset
|
[>=0]
|
Index of first array element to write. | |
count
|
[>=0]
|
Number of values to read. | |
returns
|
The read value. | ||
implements
|
IBinaryReader.ReadInt8s
|
Exceptions:
Reads all remaining data from this stream and disposes it.
[OwnerReturn, OwnerThis]
|
||||
public
virtual
method
|
ReadToEnd
()
|
|||
type
|
ByteBuffer
|
|||
returns
|
|
The read bytes. | ||
implements
|
IDataStreamOps.ReadToEnd
|
Reads an unsigned 16-bit integer value from the data stream.
public
method
|
ReadUInt16
()
|
||
type
|
int32
|
||
returns
|
The read value. | ||
implements
|
IBinaryReader.ReadUInt16
|
Exceptions:
Reads an unsigned 32-bit integer value from the data stream.
public
method
|
ReadUInt32
()
|
||
type
|
int64
|
||
returns
|
The read value. | ||
implements
|
IBinaryReader.ReadUInt32
|
Exceptions:
Reads an unsigned 8-bit integer from the data stream.
public
method
|
ReadUInt8
()
|
||
type
|
int32
|
||
returns
|
The read value. | ||
implements
|
IBinaryReader.ReadUInt8
|
Exceptions:
Skips the next bytes in the stream.
public
virtual
method
|
Skip
(int64 count)
|
||
params
|
count
|
[>=0]
|
The number of bytes to skip. |
implements
|
IDataStream.Skip
|
Converts this data stream into a random-access file.
[OwnerReturn, OwnerThis]
|
||||
public
virtual
method
|
ToFile
()
|
|||
type
|
IFile
|
|||
returns
|
|
The data file. | ||
implements
|
IDataStreamOps.ToFile
|
Remarks:
It may be necessary to copy the data stream bytes to a temporary file.
Creates an ITextStream from the data of this object.
[OwnerReturn, OwnerThis]
|
||||
public
virtual
method
|
ToTextStream
(CharacterEncoding encoding)
|
|||
type
|
ITextStream
|
|||
params
|
encoding
|
[not-null]
|
The character encoding to use. | |
returns
|
|
The data stream. | ||
implements
|
ITextStreamFactory.ToTextStream
|
Reads an unsigned 8-bit value from the stream.
public
abstract
method
|
TryReadUInt8
()
|
||
type
|
int32
|
||
returns
|
|
The
unsigned
8-bit
value
or
-1
if
the
end
of
the
stream
has
been
reached.
|
|
implements
|
IBinaryReader.TryReadUInt8
|
Writes a number of bytes to the stream.
public
abstract
method
|
Write
(ByteBuffer bytes)
|
||
params
|
bytes
|
[not-null]
|
The bytes to write. |
implements
|
IBinaryWriter.Write
|
Exceptions:
Writes a 32-bit floating point value to the data stream.
public
method
|
WriteFloat32
(float32 value)
|
||
params
|
value
|
The value to write. | |
implements
|
IBinaryWriter.WriteFloat32
|
Exceptions:
Writes 32-bit floating point values to the data stream.
public
virtual
method
|
WriteFloat32s
(float32[] array,
int32 offset,
int32 count)
|
||
params
|
array
|
[not-null]
|
The input array. |
offset
|
[>=0]
|
Index of first array element to read. | |
count
|
[>=0]
|
Number of values to write. | |
returns
|
The read value. | ||
implements
|
IBinaryWriter.WriteFloat32s
|
Exceptions:
Writes a 64-bit floating point value to the data stream.
public
method
|
WriteFloat64
(float64 value)
|
||
params
|
value
|
The value to write. | |
implements
|
IBinaryWriter.WriteFloat64
|
Exceptions:
Writes 64-bit floating point values to the data stream.
public
virtual
method
|
WriteFloat64s
(float64[] array,
int32 offset,
int32 count)
|
||
params
|
array
|
[not-null]
|
The input array. |
offset
|
[>=0]
|
Index of first array element to read. | |
count
|
[>=0]
|
Number of values to write. | |
returns
|
The read value. | ||
implements
|
IBinaryWriter.WriteFloat64s
|
Exceptions:
Writes a signed 16-bit integer value to the data stream.
public
virtual
method
|
WriteInt16
(int16 value)
|
||
params
|
value
|
The value to write. | |
implements
|
IBinaryWriter.WriteInt16
|
Exceptions:
Writes signed 16-bit integer values to the data stream.
public
virtual
method
|
WriteInt16s
(int16[] array,
int32 offset,
int32 count)
|
||
params
|
array
|
[not-null]
|
The input array. |
offset
|
[>=0]
|
Index of first array element to read. | |
count
|
[>=0]
|
Number of values to write. | |
returns
|
The read value. | ||
implements
|
IBinaryWriter.WriteInt16s
|
Exceptions:
Writes a signed 32-bit integer value to the data stream.
public
virtual
method
|
WriteInt32
(int32 value)
|
||
params
|
value
|
The value to write. | |
implements
|
IBinaryWriter.WriteInt32
|
Exceptions:
Writes signed 32-bit integer values to the data stream.
public
virtual
method
|
WriteInt32s
(int32[] array,
int32 offset,
int32 count)
|
||
params
|
array
|
[not-null]
|
The input array. |
offset
|
[>=0]
|
Index of first array element to read. | |
count
|
[>=0]
|
Number of values to write. | |
returns
|
The read value. | ||
implements
|
IBinaryWriter.WriteInt32s
|
Exceptions:
Writes a signed 64-bit integer value to the data stream.
public
virtual
method
|
WriteInt64
(int64 value)
|
||
params
|
value
|
The value to write. | |
implements
|
IBinaryWriter.WriteInt64
|
Exceptions:
Writes signed 64-bit integer values to the data stream.
public
virtual
method
|
WriteInt64s
(int64[] array,
int32 offset,
int32 count)
|
||
params
|
array
|
[not-null]
|
The input array. |
offset
|
[>=0]
|
Index of first array element to read. | |
count
|
[>=0]
|
Number of values to write. | |
returns
|
The read value. | ||
implements
|
IBinaryWriter.WriteInt64s
|
Exceptions:
Writes an 8-bit integer value to the stream.
public
abstract
method
|
WriteInt8
(int8 value)
|
||
params
|
value
|
The value to write. | |
implements
|
IBinaryWriter.WriteInt8
|
Exceptions:
Writes signed 8-bit integer values to the data stream.
public
virtual
method
|
WriteInt8s
(int8[] array,
int32 offset,
int32 count)
|
||
params
|
array
|
[not-null]
|
The input array. |
offset
|
[>=0]
|
Index of first array element to read. | |
count
|
[>=0]
|
Number of values to write. | |
returns
|
The read value. | ||
implements
|
IBinaryWriter.WriteInt8s
|
Exceptions:
Creates a new instance of DataStreamBase.
protected
constructor
|
DataStreamBase
()
|
Disposes the managed resources held by a concrete subclass. This method will be called at most once per subclass.
protected
override
method
|
DisposeManaged
()
|
||
overrides
|
Disposable.DisposeManaged
|
Remarks:
This method will only be called when a disposable object is explicitly destroyed by user code calling the Dispose method. It will not be called when the object is collected as garbage by the system.
Overriding methods must call the DisposeManaged method of their base class. The base call should be the last statement.
The DisposeManaged method is called before the DisposeUnmanaged method.
Disposes the unmanaged resources held by a concrete subclass. This method will be called exactly once per subclass.
protected
virtual
method
|
DisposeUnmanaged
()
|
||
inherited
|
Disposable.DisposeUnmanaged
|
Remarks:
Overriding methods must call the DisposeUnmanaged method of their base class. The base call should be the last statement.
The DisposeUnmanaged method is called after the DisposeManaged method.
Finishes writing to this data stream.
[EmptyBody]
|
||||
protected
virtual
method
|
DoFinish
()
|
Remarks:
The Flush method will be called after this method has returned.