Energy Core Library
Energy.Base.ByteArrayBuilder Class Reference

Builder for byte arrays. More...

Inheritance diagram for Energy.Base.ByteArrayBuilder:

Public Member Functions

 ByteArrayBuilder ()
 Constructor More...
 
 ByteArrayBuilder (byte[] data)
 Constructor from byte array More...
 
 ByteArrayBuilder (System.IO.Stream stream)
 Constructor from System.IO.Stream More...
 
void Dispose ()
 
void Clear ()
 Clear More...
 
ByteArrayBuilder Append (byte value)
 Append byte value to a stream. More...
 
ByteArrayBuilder Append (byte[] data)
 Append byte array to a stream. More...
 
ByteArrayBuilder Append (byte value, int count)
 Append byte array initialized to value to a stream. More...
 
ByteArrayBuilder Append (sbyte value)
 Append signed byte value to a stream. More...
 
ByteArrayBuilder Append (char value)
 Append char value to a stream. More...
 
ByteArrayBuilder Append (int value)
 Append integer value to a stream. More...
 
ByteArrayBuilder Append (long value)
 Append long integer value to a stream. More...
 
ByteArrayBuilder Append (uint value)
 Append integer value to a stream. More...
 
ByteArrayBuilder Append (ulong value)
 Append unsigned long integer value to a stream. More...
 
ByteArrayBuilder Append (short value)
 Append short value to a stream. More...
 
ByteArrayBuilder Append (ushort value)
 Append unsigned short value to a stream. More...
 
ByteArrayBuilder Append (bool value)
 Append unsigned short value to a stream. More...
 
ByteArrayBuilder Append (double value)
 Append double value to a stream. More...
 
ByteArrayBuilder Append (float value)
 Append double value to a stream. More...
 
ByteArrayBuilder Append (Guid guid)
 Append GUID value to a stream. More...
 
ByteArrayBuilder Append (decimal value)
 Append decimal value to a stream. More...
 
ByteArrayBuilder Append (string value, System.Text.Encoding encoding, bool raw)
 Append string to a stream. More...
 
ByteArrayBuilder Append (string value, System.Text.Encoding encoding)
 Append string to a stream. More...
 
ByteArrayBuilder Append (string value)
 Append string to a stream with default encoding. More...
 
ByteArrayBuilder Append (string value, bool raw)
 Append string to a stream with default encoding. More...
 
ByteArrayBuilder Append (DateTime value)
 Append DateTime to a stream. More...
 
byte ReadByte ()
 Read byte value from a stream More...
 
char ReadChar ()
 Read char value from a stream More...
 
sbyte ReadSByte ()
 Read signed byte value from a stream More...
 
byte [] ReadArray ()
 Read byte array from a stream More...
 
byte [] ReadArray (int length)
 Read array of bytes from stream More...
 
int ReadInt ()
 Read integer value from a stream More...
 
long ReadLong ()
 Read long integer value from a stream More...
 
short ReadShort ()
 Read short integer value from a stream More...
 
uint ReadUInt ()
 Read unsigned integer value from a stream More...
 
ulong ReadULong ()
 Read unsigned long integer value from a stream More...
 
ushort ReadUShort ()
 Read unsigned short integer value from a stream More...
 
double ReadDouble ()
 Read double value from a stream More...
 
float ReadFloat ()
 Read float value from a stream More...
 
decimal ReadDecimal ()
 Read decimal value from a stream More...
 
bool ReadBool ()
 Read boolean value from a stream More...
 
DateTime ReadDateTime ()
 Read DateTime value from a stream More...
 
Guid ReadGuid ()
 Read Guid from a stram More...
 
string ReadString (int length, System.Text.Encoding encoding)
 Read string from a stream More...
 
string ReadString (int length)
 Read string from a stream More...
 
string ReadString (System.Text.Encoding encoding)
 Read string from a stream More...
 
string ReadString ()
 Read string from a stream More...
 
string ReadBase64 ()
 Read BASE64 from stream More...
 
void WriteByte (byte value)
 Write byte value to a stream More...
 
void WriteChar (char value)
 Write unsigned byte value to a stream More...
 
void WriteSByte (sbyte value)
 Write signed byte value to a stream More...
 
void WriteArray (byte[] data)
 Write byte array to a stream More...
 
void WriteInt (int value)
 Write integer value to a stream More...
 
void WriteLong (long value)
 Write long integer value to a stream More...
 
void WriteUInt (uint value)
 Write unsigned integer value to a stream More...
 
void WriteULong (uint value)
 Write unsigned long More...
 
void WriteShort (short value)
 Write short value to a stream More...
 
void WriteUShort (ushort value)
 Write unsigned short value to a stream More...
 
void WriteBool (bool value)
 Write boolean value to a stream More...
 
void WriteDateTime (DateTime value)
 Append DateTime to a stream More...
 
void WriteGuid (Guid guid)
 Write GUID value to a stream More...
 
void WriteString (string value, System.Text.Encoding encoding)
 Write string to a stream More...
 
void WriteString (string value)
 Write string to a stream with default encoding More...
 
void WriteBase64 (string base64)
 Write bytes from BASE64 string More...
 
void Seek (int position)
 Set an absolute position in the builder for reading. More...
 
void Rewind ()
 Move to the beginning of stream. More...
 
void Tail ()
 Move to the end of stream. More...
 
void Skip (int count)
 Skip next bytes in stream. More...
 
byte [] ToArray ()
 Returns the builder as an array of bytes. More...
 
byte [] ToArray (int position, int length)
 Returns the builder as an array of bytes More...
 
override string ToString ()
 
string ToString (System.Text.Encoding encoding)
 
string ToBase64 ()
 

Static Public Member Functions

static int Compare (byte[] array1, byte[] array2)
 Compare two arrays of bytes. Returns 0 if contains the same values. More...
 
static bool AreEqual (params byte[][] array)
 
static byte [] ToByteArray (int[] array)
 Convert array of integers to a byte array. More...
 
static byte [] ToByteArray (int[] array, int width)
 Convert array of integers to a byte array. More...
 
static byte [] ToByteArray (int[] array, bool reverse)
 Convert array of integers to a byte array. More...
 
static byte [] ToByteArray (int[] array, int width, bool reverse)
 Convert array of integers to a byte array. More...
 
static byte [] SubArray (byte[] array, int start, int count)
 Get sub array of bytes from an existing one. More...
 
static byte [] SubArray (byte[] array, int start, int count, bool pad)
 Get sub array of bytes from an existing one. More...
 

Properties

byte this[int index] [get, set]
 Accessor More...
 
bool Empty [get]
 Returns true if object contains no data. More...
 
int Length [get]
 Current data length. More...
 
int Capacity [get, set]
 Buffer capacity. More...
 
System.Text.Encoding Encoding [get, set]
 String encoding. More...
 
bool End [get]
 Indicates that position marker is at end of buffer More...
 

Detailed Description

Builder for byte arrays.

Constructor & Destructor Documentation

◆ ByteArrayBuilder() [1/3]

Energy.Base.ByteArrayBuilder.ByteArrayBuilder ( )

Constructor

◆ ByteArrayBuilder() [2/3]

Energy.Base.ByteArrayBuilder.ByteArrayBuilder ( byte []  data)

Constructor from byte array

Parameters
data

◆ ByteArrayBuilder() [3/3]

Energy.Base.ByteArrayBuilder.ByteArrayBuilder ( System.IO.Stream  stream)

Constructor from System.IO.Stream

Parameters
stream

Member Function Documentation

◆ Append() [1/21]

ByteArrayBuilder Energy.Base.ByteArrayBuilder.Append ( byte  value)

Append byte value to a stream.

Parameters
value
Returns

◆ Append() [2/21]

ByteArrayBuilder Energy.Base.ByteArrayBuilder.Append ( byte []  data)

Append byte array to a stream.

Parameters
data
Returns

◆ Append() [3/21]

ByteArrayBuilder Energy.Base.ByteArrayBuilder.Append ( byte  value,
int  count 
)

Append byte array initialized to value to a stream.

Parameters
value
count
Returns

◆ Append() [4/21]

ByteArrayBuilder Energy.Base.ByteArrayBuilder.Append ( sbyte  value)

Append signed byte value to a stream.

Parameters
value
Returns

◆ Append() [5/21]

ByteArrayBuilder Energy.Base.ByteArrayBuilder.Append ( char  value)

Append char value to a stream.

Parameters
value
Returns

◆ Append() [6/21]

ByteArrayBuilder Energy.Base.ByteArrayBuilder.Append ( int  value)

Append integer value to a stream.

Parameters
value
Returns

◆ Append() [7/21]

ByteArrayBuilder Energy.Base.ByteArrayBuilder.Append ( long  value)

Append long integer value to a stream.

Parameters
value
Returns

◆ Append() [8/21]

ByteArrayBuilder Energy.Base.ByteArrayBuilder.Append ( uint  value)

Append integer value to a stream.

Parameters
value
Returns

◆ Append() [9/21]

ByteArrayBuilder Energy.Base.ByteArrayBuilder.Append ( ulong  value)

Append unsigned long integer value to a stream.

Parameters
value
Returns

◆ Append() [10/21]

ByteArrayBuilder Energy.Base.ByteArrayBuilder.Append ( short  value)

Append short value to a stream.

Parameters
value
Returns

◆ Append() [11/21]

ByteArrayBuilder Energy.Base.ByteArrayBuilder.Append ( ushort  value)

Append unsigned short value to a stream.

Parameters
value
Returns

◆ Append() [12/21]

ByteArrayBuilder Energy.Base.ByteArrayBuilder.Append ( bool  value)

Append unsigned short value to a stream.

Parameters
value
Returns

◆ Append() [13/21]

ByteArrayBuilder Energy.Base.ByteArrayBuilder.Append ( double  value)

Append double value to a stream.

Parameters
value
Returns

◆ Append() [14/21]

ByteArrayBuilder Energy.Base.ByteArrayBuilder.Append ( float  value)

Append double value to a stream.

Parameters
value
Returns

◆ Append() [15/21]

ByteArrayBuilder Energy.Base.ByteArrayBuilder.Append ( Guid  guid)

Append GUID value to a stream.

Parameters
guid

◆ Append() [16/21]

ByteArrayBuilder Energy.Base.ByteArrayBuilder.Append ( decimal  value)

Append decimal value to a stream.

Parameters
value
Returns

◆ Append() [17/21]

ByteArrayBuilder Energy.Base.ByteArrayBuilder.Append ( string  value,
System.Text.Encoding  encoding,
bool  raw 
)

Append string to a stream.

Parameters
value
encoding
raw
Returns

◆ Append() [18/21]

ByteArrayBuilder Energy.Base.ByteArrayBuilder.Append ( string  value,
System.Text.Encoding  encoding 
)

Append string to a stream.

Parameters
value
encoding
Returns

◆ Append() [19/21]

ByteArrayBuilder Energy.Base.ByteArrayBuilder.Append ( string  value)

Append string to a stream with default encoding.

Parameters
value
Returns

◆ Append() [20/21]

ByteArrayBuilder Energy.Base.ByteArrayBuilder.Append ( string  value,
bool  raw 
)

Append string to a stream with default encoding.

Parameters
value
raw
Returns

◆ Append() [21/21]

ByteArrayBuilder Energy.Base.ByteArrayBuilder.Append ( DateTime  value)

Append DateTime to a stream.

Parameters
value
Returns

◆ AreEqual()

static bool Energy.Base.ByteArrayBuilder.AreEqual ( params byte  array[][])
static

◆ Clear()

void Energy.Base.ByteArrayBuilder.Clear ( )

Clear

◆ Compare()

static int Energy.Base.ByteArrayBuilder.Compare ( byte []  array1,
byte []  array2 
)
static

Compare two arrays of bytes. Returns 0 if contains the same values.

Parameters
array1
array2
Returns

◆ Dispose()

void Energy.Base.ByteArrayBuilder.Dispose ( )

◆ ReadArray() [1/2]

byte [] Energy.Base.ByteArrayBuilder.ReadArray ( )

Read byte array from a stream

Returns

◆ ReadArray() [2/2]

byte [] Energy.Base.ByteArrayBuilder.ReadArray ( int  length)

Read array of bytes from stream

Parameters
length
Returns

◆ ReadBase64()

string Energy.Base.ByteArrayBuilder.ReadBase64 ( )

Read BASE64 from stream

Returns

◆ ReadBool()

bool Energy.Base.ByteArrayBuilder.ReadBool ( )

Read boolean value from a stream

Returns

◆ ReadByte()

byte Energy.Base.ByteArrayBuilder.ReadByte ( )

Read byte value from a stream

Returns

◆ ReadChar()

char Energy.Base.ByteArrayBuilder.ReadChar ( )

Read char value from a stream

Returns

◆ ReadDateTime()

DateTime Energy.Base.ByteArrayBuilder.ReadDateTime ( )

Read DateTime value from a stream

Returns

◆ ReadDecimal()

decimal Energy.Base.ByteArrayBuilder.ReadDecimal ( )

Read decimal value from a stream

Returns

◆ ReadDouble()

double Energy.Base.ByteArrayBuilder.ReadDouble ( )

Read double value from a stream

Returns

◆ ReadFloat()

float Energy.Base.ByteArrayBuilder.ReadFloat ( )

Read float value from a stream

Returns

◆ ReadGuid()

Guid Energy.Base.ByteArrayBuilder.ReadGuid ( )

Read Guid from a stram

Returns

◆ ReadInt()

int Energy.Base.ByteArrayBuilder.ReadInt ( )

Read integer value from a stream

Returns

◆ ReadLong()

long Energy.Base.ByteArrayBuilder.ReadLong ( )

Read long integer value from a stream

Returns

◆ ReadSByte()

sbyte Energy.Base.ByteArrayBuilder.ReadSByte ( )

Read signed byte value from a stream

Returns

◆ ReadShort()

short Energy.Base.ByteArrayBuilder.ReadShort ( )

Read short integer value from a stream

Returns

◆ ReadString() [1/4]

string Energy.Base.ByteArrayBuilder.ReadString ( int  length,
System.Text.Encoding  encoding 
)

Read string from a stream

Parameters
length
encoding
Returns

◆ ReadString() [2/4]

string Energy.Base.ByteArrayBuilder.ReadString ( int  length)

Read string from a stream

Parameters
length
Returns

◆ ReadString() [3/4]

string Energy.Base.ByteArrayBuilder.ReadString ( System.Text.Encoding  encoding)

Read string from a stream

Parameters
encoding
Returns

◆ ReadString() [4/4]

string Energy.Base.ByteArrayBuilder.ReadString ( )

Read string from a stream

Returns

◆ ReadUInt()

uint Energy.Base.ByteArrayBuilder.ReadUInt ( )

Read unsigned integer value from a stream

Returns

◆ ReadULong()

ulong Energy.Base.ByteArrayBuilder.ReadULong ( )

Read unsigned long integer value from a stream

Returns

◆ ReadUShort()

ushort Energy.Base.ByteArrayBuilder.ReadUShort ( )

Read unsigned short integer value from a stream

Returns

◆ Rewind()

void Energy.Base.ByteArrayBuilder.Rewind ( )

Move to the beginning of stream.

◆ Seek()

void Energy.Base.ByteArrayBuilder.Seek ( int  position)

Set an absolute position in the builder for reading.

Parameters
position

◆ Skip()

void Energy.Base.ByteArrayBuilder.Skip ( int  count)

Skip next bytes in stream.

Parameters
count

◆ SubArray() [1/2]

static byte [] Energy.Base.ByteArrayBuilder.SubArray ( byte []  array,
int  start,
int  count 
)
static

Get sub array of bytes from an existing one.

Parameters
array
start
count
Returns

◆ SubArray() [2/2]

static byte [] Energy.Base.ByteArrayBuilder.SubArray ( byte []  array,
int  start,
int  count,
bool  pad 
)
static

Get sub array of bytes from an existing one.

Parameters
array
start
count
pad
Returns

◆ Tail()

void Energy.Base.ByteArrayBuilder.Tail ( )

Move to the end of stream.

◆ ToArray() [1/2]

byte [] Energy.Base.ByteArrayBuilder.ToArray ( )

Returns the builder as an array of bytes.

Returns

◆ ToArray() [2/2]

byte [] Energy.Base.ByteArrayBuilder.ToArray ( int  position,
int  length 
)

Returns the builder as an array of bytes

Parameters
length
position
Returns

◆ ToBase64()

string Energy.Base.ByteArrayBuilder.ToBase64 ( )

◆ ToByteArray() [1/4]

static byte [] Energy.Base.ByteArrayBuilder.ToByteArray ( int []  array)
static

Convert array of integers to a byte array.

Parameters
array
Returns

◆ ToByteArray() [2/4]

static byte [] Energy.Base.ByteArrayBuilder.ToByteArray ( int []  array,
int  width 
)
static

Convert array of integers to a byte array.

Parameters
array
width
Returns

◆ ToByteArray() [3/4]

static byte [] Energy.Base.ByteArrayBuilder.ToByteArray ( int []  array,
bool  reverse 
)
static

Convert array of integers to a byte array.

Parameters
array
reverse
Returns

◆ ToByteArray() [4/4]

static byte [] Energy.Base.ByteArrayBuilder.ToByteArray ( int []  array,
int  width,
bool  reverse 
)
static

Convert array of integers to a byte array.

Parameters
array
width
reverse
Returns

◆ ToString() [1/2]

override string Energy.Base.ByteArrayBuilder.ToString ( )

◆ ToString() [2/2]

string Energy.Base.ByteArrayBuilder.ToString ( System.Text.Encoding  encoding)

◆ WriteArray()

void Energy.Base.ByteArrayBuilder.WriteArray ( byte []  data)

Write byte array to a stream

Parameters
data

◆ WriteBase64()

void Energy.Base.ByteArrayBuilder.WriteBase64 ( string  base64)

Write bytes from BASE64 string

Parameters
base64

◆ WriteBool()

void Energy.Base.ByteArrayBuilder.WriteBool ( bool  value)

Write boolean value to a stream

Parameters
value
Returns

◆ WriteByte()

void Energy.Base.ByteArrayBuilder.WriteByte ( byte  value)

Write byte value to a stream

Parameters
value

◆ WriteChar()

void Energy.Base.ByteArrayBuilder.WriteChar ( char  value)

Write unsigned byte value to a stream

Parameters
value

◆ WriteDateTime()

void Energy.Base.ByteArrayBuilder.WriteDateTime ( DateTime  value)

Append DateTime to a stream

Parameters
value
Returns

◆ WriteGuid()

void Energy.Base.ByteArrayBuilder.WriteGuid ( Guid  guid)

Write GUID value to a stream

Parameters
guid

◆ WriteInt()

void Energy.Base.ByteArrayBuilder.WriteInt ( int  value)

Write integer value to a stream

Parameters
value

◆ WriteLong()

void Energy.Base.ByteArrayBuilder.WriteLong ( long  value)

Write long integer value to a stream

Parameters
value

◆ WriteSByte()

void Energy.Base.ByteArrayBuilder.WriteSByte ( sbyte  value)

Write signed byte value to a stream

Parameters
value

◆ WriteShort()

void Energy.Base.ByteArrayBuilder.WriteShort ( short  value)

Write short value to a stream

Parameters
value
Returns

◆ WriteString() [1/2]

void Energy.Base.ByteArrayBuilder.WriteString ( string  value,
System.Text.Encoding  encoding 
)

Write string to a stream

Parameters
value
encoding
Returns

◆ WriteString() [2/2]

void Energy.Base.ByteArrayBuilder.WriteString ( string  value)

Write string to a stream with default encoding

Parameters
value
Returns

◆ WriteUInt()

void Energy.Base.ByteArrayBuilder.WriteUInt ( uint  value)

Write unsigned integer value to a stream

Parameters
value

◆ WriteULong()

void Energy.Base.ByteArrayBuilder.WriteULong ( uint  value)

Write unsigned long

Parameters
value

◆ WriteUShort()

void Energy.Base.ByteArrayBuilder.WriteUShort ( ushort  value)

Write unsigned short value to a stream

Parameters
value
Returns

Property Documentation

◆ Capacity

int Energy.Base.ByteArrayBuilder.Capacity
getset

Buffer capacity.

◆ Empty

bool Energy.Base.ByteArrayBuilder.Empty
get

Returns true if object contains no data.

◆ Encoding

System.Text.Encoding Energy.Base.ByteArrayBuilder.Encoding
getset

String encoding.

◆ End

bool Energy.Base.ByteArrayBuilder.End
get

Indicates that position marker is at end of buffer

◆ Length

int Energy.Base.ByteArrayBuilder.Length
get

Current data length.

◆ this[int index]

byte Energy.Base.ByteArrayBuilder.this[int index]
getset

Accessor

Parameters
index
Returns

The documentation for this class was generated from the following file: