Byter 3.0.0

Need better documentation? READ THIS IN GITHUB (click me)

⭐ Your star is the light at the end of our tunnel. Lead us out of the darkness by starring Byter on GitHub. Star me please, I beg you! 💙

Byter

powered by ALEC1O

Project

Get basic information about this project called Byter

!Content removed: Need better documentation? READ THIS IN GITHUB (click me)

Overview

About

Byter is a C# serializer. It can serialize and deserialize from primitive type e.g (class, struct, list, array, string, int, long, double, ...), It can serialize complex data fast and easy.

Website:

Repository: GitHub

Installing

Official publisher

!Content removed: Need better documentation? READ THIS IN GITHUB (click me)

Usage

Integration and interaction example codes

!Content removed: Need better documentation? READ THIS IN GITHUB (click me)

v1.x.x and v2.x.x

📄 Writer

Constructor

• () : Writer Create instance with empty internal buffer

• (Writer writer) : Writer Create instance and copy buffer of (Writer) as internal buffer

• (ref Writer writer) : Writer Create instance and copy buffer of (ref Writer) as internal buffer

Proprieties

• Length : int Return buffer length.

Methods

• Write(T value) : void Write content in internal buffer

• GetBytes() : byte[] Return buffer from (Writer) instance as byte[])

• GetList() : List Return buffer from (Writer) instance as List<byte>

• Clear(): void Clear internal buffer from (Writer) instance

📄 Reader

Constructor

• (byte[] buffer) : Reader Create instance using (Byte[]) as internal buffer

• (Writer writer) : Reader Create instance using (Writer) as internal buffer

• (ref Writer writer) : Reader Create instance using (ref Writer) as internal buffer

Proprieties

• Success : bool Return true if deserialized successful.

• Position : int Return current read index.

• Length : int Return buffer length.

Methods

• Seek(int position) : void Move position (internal buffer index)

• Read<T>() : T Read content from iternal buffer.

• Read<string>(Encoding encoding) : string Read custom encoding string.

📄 Example

• Writer

  using Byter;
  
  Writer w = new();
  
  // write data
  
  w.Write("Powered by ALEC1O");
  w.Write("由 ALEC1O 提供支持", Encoding.UTF32);
  w.Write((int)1000000);` // 1.000.000
  w.Write((char)'A');
  w.Write((long)-1000000000); // -100.0000.000
  w.Write((byte[])[0, 1, 2, 3]);
  
  // Float(1|2|3) only available in version 2
  w.Write(new Float2(-100F, 300F));
  w.Write(new Float3(-100F, 300F, 600F));
  w.Write(new Float4(-100F, 300F, 600F, 900F));
  
  // get buffer
  
  byte[] buffer = w.GetBytes();
  
  // example send buffer
  Magic.Send(buffer);
  

• Reader

  using Byter;
  
  // example receive buffer
  byte[] buffer = Magic.Receive();
  
  // create instance
  Reader r = new()
  
  // read data
  
  string noticeInEnglish = r.Read(); // Powered by ALEC1O
  string noticeInChinese = r.Read(Encoding.UTF32); // 由 ALEC1O 提供支持
  int myInt = r.Read(); // 1.000.000
  char myChar = r.Read(); // 'A'
  long myLong = r.Read(); // -100.0000.000
  byte[] myBytes = r.Read(); // [0, 1, 2, 3]
  
  // Float(1|2|3) only available in version 2
  Float2 myFloat2 = r.Read(); // [x: -100F] [y: 300F]
  Float3 myFloat3 = r.Read(); // [x: -100F] [y: 300F] [z: 600F]
  Float4 myFloat4 = r.Read(); // [x: -100F] [y: 300F] [z: 600F] [w: 900F]
  
  if (r.Sucess)
  {
      // sucess on read all data
  }
  else
  {
      // one or more data isn't found when deserialize. Might ignore this buffer!
  }
  

• Dynamic Read Technical

  var r = new Reader(...);
  
  var topic = r.Read(Encoding.ASCII);
  
  if(!r.Sucess) return; // ignore this 
  
  if (topic == "login")
  {
      string username = r.Read(Encoding.UTF32);
      string password = r.Read(Encoding.ASCII);
  
      if (!r.Sucess) return; // ignore this
      // login user...
  }
  else if(topic == "get user address")
  {
      ulong userId  = r.Read();
      string token = r.Read(Encoding.ASCII);
  
      if (!r.Sucess) return; // ignore this
      // get user adress...
  }
  ...
  else
  {
      // ignore this. (Topic not found)
  }
  

v3.x.x

📄 Primitive

Constructor

• () : Primitive Create instance with empty internal buffer

• (byte[] buffer) : Primitive Create instance using (Byte[]) as internal buffer

Proprieties

• Position : int Return internal reading index/position.

• IsValid : bool Return (true) if data was read successful. otherwise (false)

• Add : IPrimitiveAdd Object used to (read/get) content from internal (Primitive) buffer

• Get : IPrimitiveGet Object used to (write/add) content in internal (Primitive) buffer

Methods

• GetBytes() : byte[] Return buffer from (Primitive) instance as byte[])

• GetList() : List Return buffer from (Primitive) instance as List<byte>

• Reset(): void Clear internal buffer from (Primitive) instance

📄 IPrimitiveAdd

Methods

• Bool(bool value) void (Write/Add) element typeof(bool) in internal buffer

• Byte(byte value) void (Write/Add) element typeof(byte) in internal buffer

• SByte(sbyte value) void (Write/Add) element typeof(sbyte) in internal buffer

• Char(char value) void (Write/Add) element typeof(char) in internal buffer

• Short(short value) void (Write/Add) element typeof(short) in internal buffer

• UShort(ushort value) void (Write/Add) element typeof(ushort) in internal buffer

• Int(int value) void (Write/Add) element typeof(int) in internal buffer

• UInt(uint value) void (Write/Add) element typeof(uint) in internal buffer

• Float(float value) void (Write/Add) element typeof(float) in internal buffer

• Enum<T>(T value) void (Write/Add) element typeof(enum) in internal buffer

• Long(long value) void (Write/Add) element typeof(long) in internal buffer

• ULong(ulong value) void (Write/Add) element typeof(ulong) in internal buffer

• Double(double value) void (Write/Add) element typeof(double) in internal buffer

• DateTime(DateTime value) void (Write/Add) element typeof(DateTime) in internal buffer

• Decimal(decimal value) void (Write/Add) element typeof(decimal) in internal buffer

• String(string value) void (Write/Add) element typeof(string) in internal buffer

• Class<T>(T value) void (Write/Add) element typeof(T) in internal buffer

• Struct<T>(T value) void (Write/Add) element typeof(T) in internal buffer

• Array<T>(T value) void (Write/Add) element typeof(T[]) in internal buffer

• List<T>(List value) void (Write/Add) element typeof(List) in internal buffer

• BigInteger(BigInteger value) void (Write/Add) element typeof(BigInteger) in internal buffer

• Bytes(byte[] value) void (Write/Add) element typeof(byte[]) in internal buffer

📄 IPrimitiveGet

Methods

• Bool() bool (Read/Get) element typeof(bool) from internal buffer

• Byte() byte (Read/Get) element typeof(byte) from internal buffer

• SByte() sbyte (Read/Get) element typeof(sbyte) from internal buffer

• Char() char (Read/Get) element typeof(char) from internal buffer

• Short() short (Read/Get) element typeof(short) from internal buffer

• UShort() ushort (Read/Get) element typeof(ushort) from internal buffer

• Int() int (Read/Get) element typeof(int) from internal buffer

• UInt() uint (Read/Get) element typeof(uint) from internal buffer

• Float() float (Read/Get) element typeof(float) from internal buffer

• Enum<T>() T (Read/Get) element typeof(enum) from internal buffer

• Long() long (Read/Get) element typeof(long) from internal buffer

• ULong() ulong (Read/Get) element typeof(ulong) from internal buffer

• Double() double (Read/Get) element typeof(double) from internal buffer

• DateTime() DateTime (Read/Get) element typeof(DateTime) from internal buffer

• Decimal() decimal (Read/Get) element typeof(decimal) from internal buffer

• String() string (Read/Get) element typeof(string) from internal buffer

• Class<T> () T (Read/Get) element typeof(T) from internal buffer

• Struct<T>() T (Read/Get) element typeof(T) from internal buffer

• Array<T>() T[] (Read/Get) element typeof(T[]) from internal buffer

• List<T>() List (Read/Get) element typeof(List

• BigInteger() BigInteger (Read/Get) element typeof(BigInteger) from internal buffer

• Bytes() byte[] (Read/Get) element typeof(byte[]) from internal buffer

📄 Example

• Add Element

  using Byter;
  
  Primitive primitive = new();
  
  // write elements
  
  primitive.Add.Class(myCharacterInfoClass);
  primitive.Add.Array(myCharacterArray);
  primitive.Add.List(myLogList);
  primitive.Add.Struct(myDeviceStruct);
  primitive.Add.DateTime(DateTime.UtcNow);
  primitive.Add.Enum(MyEnum.Option1);
  primitive.Add.Bytes(myImageBuffer);
  
  // send buffer
  
  byte[] buffer = primitive.GetBytes();
  Magic.Send(buffer); // EXAMPLE!
  

• Get Element

  using Byter;
  
  // receive bugger
  
  byte[] buffer = Magic.Receive(); // EXAMPLE!
  
  Primitive primitive = new(buffer);
  
  // read elements
  
  var myCharacterInfoClass = primitive.Get.Class();
  var myCharacterArray = primitive.Get.Array();
  var myLogList = primitive.Get.List();
  var myDeviceStruct = primitive.Get.Struct();
  var myTime = primitive.Get.DateTime();
  var myEnum = primitive.Get.Enum();
  var myImageBuffer = primitive.Get.Bytes();
  
  if (primitive.IsValid)
  {
      // sucess on read all data
  }
  else
  {
      // one or more data isn't found when deserialize. Might ignore this buffer!
  }
  
  

• Dynamic Read Technical

  Primitive primitive = new(...);
  
  var topic = primitive.Get.String();
  
  if(!primitive.IsValid) return; // ignore this 
  
  if (topic == "login")
  {
      var loginInfo = primitive.Get.Class();
  
      if (!primitive.IsValid) return; // ignore this
      // login user...
  }
  else if (topic == "get user address")
  {
      var getUserAddressInfo = primitive.Get.Class();
  
      if (!primitive.IsValid) return; // ignore this
      // get user adress...
  }
  ...
  else
  {
      // ignore this. (Topic not found)
  }
  

Overhead (supported types list)

Byter overhead information

!Content removed: Need better documentation? READ THIS IN GITHUB (click me)