StreamPeer

public bool BigEndian { get; set; }

Byte order for subsequent numeric operations and length prefixes. Defaults to false for little-endian; true selects big-endian. Changing it does not reorder existing bytes or raw PutData arrays.

public short Get16();

Reads 2 bytes as signed 16-bit. Widths greater than one byte follow BigEndian. Returns no Error: ensure a complete field beforehand; a short/failed read does not yield a trustworthy number.

public int Get32();

Reads 4 bytes as signed 32-bit. Widths greater than one byte follow BigEndian. Returns no Error: ensure a complete field beforehand; a short/failed read does not yield a trustworthy number.

public long Get64();

Reads 8 bytes as signed 64-bit. Widths greater than one byte follow BigEndian. Returns no Error: ensure a complete field beforehand; a short/failed read does not yield a trustworthy number.

public sbyte Get8();

Reads 1 byte as signed 8-bit. Widths greater than one byte follow BigEndian. Returns no Error: ensure a complete field beforehand; a short/failed read does not yield a trustworthy number.

public int GetAvailableBytes();

Returns readable-byte availability for the implementation. Not the next message size or a guarantee of a complete field/packet. For StreamPeerBuffer this is GetSize()-GetPosition().

public Reckfell.Collections.Array GetData(int bytes);

Attempts to read the requested byte count and returns [Error, byte[]]. Check Error before using data. Socket streams can wait for missing bytes; a short StreamPeerBuffer read reports failure after already consuming the available portion.

public double GetDouble();

Reads 8 bytes as binary64. Widths greater than one byte follow BigEndian. Returns no Error: ensure a complete field beforehand; a short/failed read does not yield a trustworthy number.

public float GetFloat();

Reads 4 bytes as binary32. Widths greater than one byte follow BigEndian. Returns no Error: ensure a complete field beforehand; a short/failed read does not yield a trustworthy number.

public float GetHalf();

Reads 2 bytes as binary16. Widths greater than one byte follow BigEndian. Returns no Error: ensure a complete field beforehand; a short/failed read does not yield a trustworthy number. binary16 has less precision/range than C# float.

public Reckfell.Collections.Array GetPartialData(int bytes);

Reads up to the requested byte count without requiring all bytes in this call. Returns [Error, byte[]]; on success the array length is the actual received count. Accumulate incomplete messages in your own buffer.

public string GetString(int bytes = -1);

Reads the plain string format paired with PutString. bytes<0 reads a 32-bit length prefix first; otherwise reads the exact byte count without a prefix. Use the UTF-8 pair for Unicode. Bound externally supplied lengths before allocation.

public ushort GetU16();

Reads 2 bytes as unsigned 16-bit. Widths greater than one byte follow BigEndian. Returns no Error: ensure a complete field beforehand; a short/failed read does not yield a trustworthy number.

public uint GetU32();

Reads 4 bytes as unsigned 32-bit. Widths greater than one byte follow BigEndian. Returns no Error: ensure a complete field beforehand; a short/failed read does not yield a trustworthy number.

public ulong GetU64();

Reads 8 bytes as unsigned 64-bit. Widths greater than one byte follow BigEndian. Returns no Error: ensure a complete field beforehand; a short/failed read does not yield a trustworthy number.

public byte GetU8();

Reads 1 byte as unsigned 8-bit. Widths greater than one byte follow BigEndian. Returns no Error: ensure a complete field beforehand; a short/failed read does not yield a trustworthy number.

public string GetUtf8String(int bytes = -1);

Reads UTF-8 text. bytes<0 consumes its own 32-bit prefix; a supplied count reads those bytes only. Do not pass a C# character count. No separate Error is returned; explicitly control lengths/decoding for strict external formats.

public Variant GetVar(bool allowObjects = false);

Reads a length-prefixed binary Variant produced by PutVar. Not JSON. Check input trust, size and expected type; the method does not impose an application packet-size limit or return a separate Error.

public bool IsBigEndianEnabled();

Returns the same flag as BigEndian; does not detect the byte order of loaded data.

public void Put16(short value);

Writes 2 bytes as signed 16-bit. Widths greater than one byte follow BigEndian. Returns no Error; use explicit raw-write result checks for fallible transports.

public void Put32(int value);

Writes 4 bytes as signed 32-bit. Widths greater than one byte follow BigEndian. Returns no Error; use explicit raw-write result checks for fallible transports.

public void Put64(long value);

Writes 8 bytes as signed 64-bit. Widths greater than one byte follow BigEndian. Returns no Error; use explicit raw-write result checks for fallible transports.

public void Put8(sbyte value);

Writes 1 byte as signed 8-bit. Widths greater than one byte follow BigEndian. Returns no Error; use explicit raw-write result checks for fallible transports.

public Error PutData(byte[] data);

Writes raw bytes without an automatic header, length or reordering. Returns Error; full socket writes can wait. One call does not define a TCP message boundary.

public Error PutData(ReadOnlySpan<byte> data);

Writes raw bytes without an automatic header, length or reordering. Returns Error; full socket writes can wait. One call does not define a TCP message boundary.

public void PutDouble(double value);

Writes 8 bytes as binary64. Widths greater than one byte follow BigEndian. Returns no Error; use explicit raw-write result checks for fallible transports.

public void PutFloat(float value);

Writes 4 bytes as binary32. Widths greater than one byte follow BigEndian. Returns no Error; use explicit raw-write result checks for fallible transports.

public void PutHalf(float value);

Writes 2 bytes as binary16. Widths greater than one byte follow BigEndian. Returns no Error; use explicit raw-write result checks for fallible transports. binary16 has less precision/range than C# float.

public Reckfell.Collections.Array PutPartialData(byte[] data);

Attempts a partial raw write and returns [Error, count]. Check both values and resume from the remaining portion when needed. A successful StreamPeerBuffer write normally accepts the entire array.

public Reckfell.Collections.Array PutPartialData(ReadOnlySpan<byte> data);

Attempts a partial raw write and returns [Error, count]. Check both values and resume from the remaining portion when needed. A successful StreamPeerBuffer write normally accepts the entire array.

public void PutString(string value);

Writes ASCII representation with a 32-bit byte-length prefix. Use PutUtf8String for Unicode. Prefix byte order follows BigEndian; a terminator is not part of the payload string.

public void PutU16(ushort value);

Writes 2 bytes as unsigned 16-bit. Widths greater than one byte follow BigEndian. Returns no Error; use explicit raw-write result checks for fallible transports.

public void PutU32(uint value);

Writes 4 bytes as unsigned 32-bit. Widths greater than one byte follow BigEndian. Returns no Error; use explicit raw-write result checks for fallible transports.

public void PutU64(ulong value);

Writes 8 bytes as unsigned 64-bit. Widths greater than one byte follow BigEndian. Returns no Error; use explicit raw-write result checks for fallible transports.

public void PutU8(byte value);

Writes 1 byte as unsigned 8-bit. Widths greater than one byte follow BigEndian. Returns no Error; use explicit raw-write result checks for fallible transports.

public void PutUtf8String(string value);

Writes UTF-8 bytes with a 32-bit byte-length prefix. Emoji/Cyrillic byte count differs from C# string.Length. Read with GetUtf8String(), or consume the prefix separately and call GetUtf8String(byte_count).

public void PutVar(Variant value, bool fullObjects = false);

Writes a 32-bit length and binary Variant representation. A separate engine format, not JSON or complete game-state serialization. BigEndian affects the outer prefix, not re-encoding the internal Variant format.

public void SetBigEndian(bool enable);

Sets BigEndian for subsequent operations. Reader and writer must agree on byte order and field types.