StreamExtensions Class

Defines extension functions related to Stream manipulation.

Inheritance Hierarchy

SystemObject
GSF.IOStreamExtensions

Namespace: GSF.IO
Assembly: GSF.Core (in GSF.Core.dll) Version: 2.4.181-beta

Syntax

C++

JavaScript

Copy

public static class StreamExtensions

<ExtensionAttribute>
Public NotInheritable Class StreamExtensions

[ExtensionAttribute]
public ref class StreamExtensions abstract sealed

[<AbstractClassAttribute>]
[<SealedAttribute>]
[<ExtensionAttribute>]
type StreamExtensions = class end

GSF.IO.StreamExtensions = function();

Type.createClass(
	'GSF.IO.StreamExtensions');

View Source

The StreamExtensions type exposes the following members.

Methods

	Name	Description
	CopyStream	Obsolete. Copies input Stream onto output Stream.
	CopyTo	Writes the contents of a stream to the provided stream.
	Read7BitUInt32	Reads the 7-bit encoded value from the stream.
	ReadAll	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.
	ReadBoolean	Reads the value from the stream in little endian format.
	ReadBytes(Stream)	Reads a byte array from a Stream. The number of bytes should be prefixed in the stream.
	ReadBytes(Stream, Int32)	Reads a byte array from a Stream. The number of bytes should be prefixed in the stream.
	ReadChar	Reads the value from the stream in little endian format.
	ReadDateTime	Reads the value from the stream in little endian format.
	ReadDecimal	Reads a decimal from the stream in Little Endian bytes.
	ReadDouble	Reads the value from the stream in little endian format.
	ReadGuid	Reads a Guid from the stream in Little Endian bytes.
	ReadInt16	Reads the value from the stream in little endian format.
	ReadInt32	Reads the value from the stream in little endian format.
	ReadInt32Collection	Writes the supplied string to a Stream in UTF8 encoding.
	ReadInt64	Reads the value from the stream in little endian format.
	ReadNextByte	Read a byte from the stream. Will throw an exception if the end of the stream has been reached.
	ReadNullableString	Reads a string from a Stream that was encoded in UTF8. Value can be null and is prefixed with a boolean.
	ReadObject	Reads an object from a stream.
	ReadSByte	Reads the value from the stream in little endian format.
	ReadSingle	Reads the value from the stream in little endian format.
	ReadStream	Reads entire Stream contents, and returns Byte array of data.
	ReadString	Reads a string from a Stream that was encoded in UTF8.
	ReadStringCollection	Writes the supplied string to a Stream in UTF8 encoding.
	ReadUInt16	Reads the value from the stream in little endian format.
	ReadUInt32	Reads the value from the stream in little endian format.
	ReadUInt64	Reads the value from the stream in little endian format.
	Write(Stream, Boolean)	Writes the supplied value to stream in little endian format.
	Write(Stream, Byte)	Writes the supplied value to in little endian format.
	Write(Stream, Byte)	Writes the entire buffer to the stream
	Write(Stream, Char)	Writes the supplied value to stream in little endian format.
	Write(Stream, DateTime)	Writes the supplied value to stream in little endian format.
	Write(Stream, Decimal)	Writes the supplied string to a Stream in UTF8 encoding.
	Write(Stream, Double)	Writes the supplied value to stream in little endian format.
	Write(Stream, Guid)	Writes a guid in little endian bytes to the stream
	Write(Stream, Int16)	Writes the supplied value to stream in little endian format.
	Write(Stream, Int32)	Writes the supplied value to stream in little endian format.
	Write(Stream, Int64)	Writes the supplied value to stream in little endian format.
	Write(Stream, SByte)	Writes the supplied value to stream in little endian format.
	Write(Stream, Single)	Writes the supplied value to stream in little endian format.
	Write(Stream, String)	Writes the supplied string to a Stream in UTF8 encoding.
	Write(Stream, UInt16)	Writes the supplied value to stream in little endian format.
	Write(Stream, UInt32)	Writes the supplied value to stream in little endian format.
	Write(Stream, UInt64)	Writes the supplied value to stream in little endian format.
	WriteCollection(Stream, ICollectionInt32)	Writes the supplied Collection to a Stream.
	WriteCollection(Stream, ICollectionString)	Writes the supplied Collection to a Stream.
	WriteNullable	Writes the supplied string to a Stream in UTF8 encoding with a prefix if the value is null
	WriteObject	Encodes an object on a stream.
	WriteWithLength	Writes the supplied value to stream along with prefixing the length so it can be properly read as a unit.

Top

Reference

GSF.IO Namespace