BinaryStreamPointerBase Class

An implementation of BinaryStreamBase that is pointer based.

Definition

Namespace: SnapDB.IO
Assembly: SnapDB (in SnapDB.dll) Version: 1.0.102.0 -- Release Build+29075351d0e5aa4dea46a5c520805222f672dc2e

C#View Source Request Example

public abstract class BinaryStreamPointerBase : BinaryStreamBase

VBView Source Request Example

Public MustInherit Class BinaryStreamPointerBase
	Inherits BinaryStreamBase

C++View Source Request Example

public ref class BinaryStreamPointerBase abstract : public BinaryStreamBase

JavaScriptView Source Request Example

SnapDB.IO.BinaryStreamPointerBase = function();

Type.createClass(
	'SnapDB.IO.BinaryStreamPointerBase',
	SnapDB.IO.BinaryStreamBase);

Inheritance: Object BinaryStreamBase BinaryStreamPointerBase

Derived: SnapDB.IO.UnmanagedBinaryStream
SnapDB.IO.UnmanagedBinaryStreamPointerWrapper

Constructors

BinaryStreamPointerBase

Creates a BinaryStreamPointerBase.

Properties

CanRead	Indicates whether or not the stream allows reading. (Overrides BinaryStreamBaseCanRead)
CanSeek	Indicates whether or not the stream allows seeking. (Overrides BinaryStreamBaseCanSeek)
CanWrite	Indicates whether or not the stream allows writing. (Overrides BinaryStreamBaseCanWrite)
Length	Throws a NotSupportedException since getting the length of this stream is not supported. (Overrides BinaryStreamBaseLength)
PointerVersion	Gets the pointer version number, assuming that this binary stream has an unmanaged buffer backing this stream. If the pointer version is the same, then any pointer acquired is still valid.
Position	Gets or sets the current position for the stream. (Overrides BinaryStreamBasePosition)
RemainingReadLength	Returns the number of bytes available at the end of the stream.
RemainingWriteLength	Returns the number of bytes available at the end of the stream for writing purposes.

Methods

Copy	Copies a block of data from one position in the stream to another position within the same stream. (Overrides BinaryStreamBaseCopy(Int64, Int64, Int32))
Dispose	Releases all the resources used by the BinaryStreamBase object. (Inherited from BinaryStreamBase)
Dispose(Boolean)	Releases the unmanaged resources used by the BinaryStreamBase object and optionally releases the managed resources. (Inherited from BinaryStreamBase)
Equals	Determines whether the specified object is equal to the current object. (Inherited from Object)
Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object)
Flush	Flushes any buffered data or state within the stream. This method intentionally does nothing, as there is no buffering to flush. (Overrides BinaryStreamBaseFlush)
GetHashCode	Serves as the default hash function. (Inherited from Object)
GetReadPointer(Int64, Int32)	Gets a read pointer to a specified position in the stream for a specified length of data.
GetReadPointer(Int64, Int32, Boolean)	Gets a read pointer to a specified position in the stream for a specified length of data and determines if the stream supports writing at that position.
GetType	Gets the Type of the current instance. (Inherited from Object)
GetWritePointer	Gets a pointer to the specified write position in the binary stream that can be used for writing up the provided length and reserving space for writing the data. Current position does not get advanced after calling this function.
InsertBytes	Inserts a certain number of bytes into the stream, shifting valid data to the right. The stream's position remains unchanged. (i.e., pointing to the beginning of the newly inserted bytes). (Inherited from BinaryStreamBase)
MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object)
Read	Reads a specified number of bytes from the BinaryStream and advances the position by that amount. (Overrides BinaryStreamBaseRead(Byte, Int32, Int32))
Read7BitUInt32	Reads a 7-bit encoded unsigned 32-bit integer (UInt32) from the stream. (Overrides BinaryStreamBaseRead7BitUInt32)
Read7BitUInt64	Reads a 7-bit encoded unsigned 64-bit integer (UInt64) from the stream. (Overrides BinaryStreamBaseRead7BitUInt64)
ReadAll(Byte*, Int32)	Reads from the underlying stream in little-endian format. Advancing the position. (Inherited from BinaryStreamBase)
ReadAll(Byte, Int32, Int32)	Reads all of the provided bytes. Will not return prematurely, but continue to execute a Read(Byte, Int32, Int32) command until the entire length has been read. (Inherited from BinaryStreamBase)
ReadBoolean	Reads from the underlying stream in little-endian format. Advancing the position. (Inherited from BinaryStreamBase)
ReadBytes	Reads from the underlying stream in little-endian format. Advancing the position. (Inherited from BinaryStreamBase)
ReadBytes(Int32)	Reads from the underlying stream in little-endian format. Advancing the position. (Inherited from BinaryStreamBase)
ReadDateTime	Reads from the underlying stream in little-endian format. Advancing the position. (Inherited from BinaryStreamBase)
ReadDecimal	Reads from the underlying stream in little-endian format. Advancing the position. (Inherited from BinaryStreamBase)
ReadDouble	Reads from the underlying stream in little-endian format. Advancing the position. (Inherited from BinaryStreamBase)
ReadGuid	Reads from the underlying stream in little-endian format. Advancing the position. (Inherited from BinaryStreamBase)
ReadInt16	Reads a single unsigned byte (UInt16) from the stream. (Overrides BinaryStreamBaseReadInt16)
ReadInt32	Reads a single unsigned byte (UInt32) from the stream. (Overrides BinaryStreamBaseReadInt32)
ReadInt64	Reads a single unsigned byte (UInt64) from the stream. (Overrides BinaryStreamBaseReadInt64)
ReadInt8	Reads from the underlying stream in little-endian format. Advancing the position. (Inherited from BinaryStreamBase)
ReadSingle	Reads from the underlying stream in little-endian format. Advancing the position. (Inherited from BinaryStreamBase)
ReadString	Reads from the underlying stream in little-endian format. Advancing the position. (Inherited from BinaryStreamBase)
ReadUInt	Reads from the underlying stream in little-endian format. Advancing the position. (Inherited from BinaryStreamBase)
ReadUInt16	Reads from the underlying stream in little-endian format. Advancing the position. (Inherited from BinaryStreamBase)
ReadUInt24	Reads from the underlying stream in little-endian format. Advancing the position. (Inherited from BinaryStreamBase)
ReadUInt32	Reads from the underlying stream in little-endian format. Advancing the position. (Inherited from BinaryStreamBase)
ReadUInt40	Reads from the underlying stream in little-endian format. Advancing the position. (Inherited from BinaryStreamBase)
ReadUInt48	Reads from the underlying stream in little-endian format. Advancing the position. (Inherited from BinaryStreamBase)
ReadUInt56	Reads from the underlying stream in little-endian format. Advancing the position. (Inherited from BinaryStreamBase)
ReadUInt64	Reads from the underlying stream in little-endian format. Advancing the position. (Inherited from BinaryStreamBase)
ReadUInt8	Reads a single unsigned byte (UInt8) from the stream. (Overrides BinaryStreamBaseReadUInt8)
RemoveBytes	Removes a certain number of bytes from the stream, shifting valid data after this location to the left. The stream's position remains unchanged. (i.e., pointing to where the data used to exist). (Inherited from BinaryStreamBase)
Seek	When overridden in a derived class, sets the position within the current stream. (Inherited from BinaryStreamBase)
SetLength	Sets the length of the BinaryStream, which is not supported and will throw a NotSupportedException. (Overrides BinaryStreamBaseSetLength(Int64))
ToString	Returns a string that represents the current object. (Inherited from Object)
TryReadBytes	Attempts to read a byte array from the stream with a specified maximum length. (Inherited from BinaryStreamBase)
TryReadString	Attempts to read a byte array from the stream with a specified maximum length. (Inherited from BinaryStreamBase)
UpdateLocalBuffer	Updates the local buffer data. (Inherited from BinaryStreamBase)
Write(Boolean)	Writes the specified value to the underlying stream in little-endian format. (Inherited from BinaryStreamBase)
Write(Byte)	Writes the specified value to the underlying stream in little-endian format. (Inherited from BinaryStreamBase)
Write(Byte)	Writes a single byte to the stream. (Overrides BinaryStreamBaseWrite(Byte))
Write(DateTime)	Writes the specified value to the underlying stream in little-endian format. (Inherited from BinaryStreamBase)
Write(Decimal)	Writes the specified value to the underlying stream in little-endian format. (Inherited from BinaryStreamBase)
Write(Double)	Writes the specified value to the underlying stream in little-endian format. (Inherited from BinaryStreamBase)
Write(Guid)	Writes the specified value to the underlying stream in little-endian format. (Inherited from BinaryStreamBase)
Write(Int16)	Writes a single short to the stream. (Overrides BinaryStreamBaseWrite(Int16))
Write(Int32)	Writes a single int to the stream. (Overrides BinaryStreamBaseWrite(Int32))
Write(Int64)	Writes a single long to the stream. (Overrides BinaryStreamBaseWrite(Int64))
Write(SByte)	Writes the specified value to the underlying stream in little-endian format. (Inherited from BinaryStreamBase)
Write(Single)	Writes the specified value to the underlying stream in little-endian format. (Inherited from BinaryStreamBase)
Write(String)	Writes the specified value to the underlying stream in little-endian format. (Inherited from BinaryStreamBase)
Write(UInt16)	Writes the specified value to the underlying stream in little-endian format. (Inherited from BinaryStreamBase)
Write(UInt32)	Writes the specified value to the underlying stream in little-endian format. (Inherited from BinaryStreamBase)
Write(UInt64)	Writes the specified value to the underlying stream in little-endian format. (Inherited from BinaryStreamBase)
Write(Byte*, Int32)	Writes a block of data from a pointer to the stream. (Overrides BinaryStreamBaseWrite(Byte*, Int32))
Write(Byte, Int32, Int32)	Writes a block of data from a byte array to the stream, starting from a specified offset and for a specified count of bytes. (Overrides BinaryStreamBaseWrite(Byte, Int32, Int32))
Write7Bit(UInt32)	Writes a single uint to the stream. (Overrides BinaryStreamBaseWrite7Bit(UInt32))
Write7Bit(UInt64)	Writes a single ulong to the stream. (Overrides BinaryStreamBaseWrite7Bit(UInt64))
WriteUInt	Writes the specified value to the underlying stream in little-endian format. (Inherited from BinaryStreamBase)
WriteUInt24	Writes the specified value to the underlying stream in little-endian format. (Inherited from BinaryStreamBase)
WriteUInt40	Writes the specified value to the underlying stream in little-endian format. (Inherited from BinaryStreamBase)
WriteUInt48	Writes the specified value to the underlying stream in little-endian format. (Inherited from BinaryStreamBase)
WriteUInt56	Writes the specified value to the underlying stream in little-endian format. (Inherited from BinaryStreamBase)
WriteWithLength	Writes the specified value to the underlying stream in little-endian format. (Inherited from BinaryStreamBase)

Fields

Current	The current position data.
First	The first position of the block.
FirstPosition	The position that corresponds to the first byte in the buffer.
LastPosition	Contains the position for the last position.
LastRead	One past the last address for reading.
LastWrite	One past the last address for writing.
Stream	A Stream implementation of this BinaryStreamBase (Inherited from BinaryStreamBase)