Msgpack

README.md

@@ -1,2 +1,66 @@
 # Msgpack-Fatma-Ebrahim
-a Go package that implements MessagePack serialization and deserialization.
+a Go library that implements MessagePack serialization and deserialization.
+
+Check this link to learn more: https://github.com/msgpack/msgpack/blob/master/spec.md
+
+## Functions:
+### `Serialize(elementVal any) []byte`
+serializes a single element into a byte array
+
+### `Deserialize(value []byte) any`
+deserializes a byte array into a single element
+
+### `Pack(obj interface{}) ([]byte, error)`
+packs an object into a byte array
+
+### `Unpack(bytes []byte, obj interface{}) (any, error)`
+unpacks a byte array into an object
+
+
+## How to Use:
+### Step 1: Install the library using `go get`
+
+  ```bash
+  go get github.com/codescalersinternships/Msgpack-Fatma-Ebrahim
+  ```
+
+This command fetches the library and adds it to your project's `go.mod` file.
+
+### Step 2: Import and use the library in your code
+
+  After running `go get`, you can import the library into your project and use the functions as described:
+
+
+```
+package main
+
+import (
+	"fmt"
+	msgpack "github.com/codescalersinternships/Msgpack-Fatma-Ebrahim/pkg"
+)
+
+type Object struct {
+	IsObject bool
+	Flag     bool
+}
+
+func main() {
+	object := Object{
+		IsObject: true,
+		Flag:     false,
+	}
+
+	packed, err := msgpack.Pack(object)
+	if err != nil {
+		fmt.Println(err)
+	}
+
+	var obj Object
+	_, err = msgpack.Unpack(packed, &obj)
+	if err != nil {
+		fmt.Println(err)
+	}
+
+	fmt.Printf("Object: %+v\n", obj)
+}
+```

cmd/main.go

@@ -0,0 +1,61 @@
+package main
+
+import (
+	"fmt"
+	msgpack "github.com/codescalersinternships/Msgpack-Fatma-Ebrahim/pkg"
+)
+
+func main() {
+	arr := make([]float32, 3)
+	arr[0] = 0
+	arr[1] = 7.1
+	arr[2] = 9.8
+
+	m := make(map[any]any)
+	m["hello"] = 10
+	m["world"] = -20
+
+	typed_map := make(map[float32]int16)
+	typed_map[1.1] = 1
+	typed_map[2.2] = 2
+
+	object := msgpack.Object{
+		IsObject: true,
+		Flag:     false,
+		Unum:     0,
+		Snum:     -1000,
+		Fnum:     3.14,
+		Str:      "Fatma",
+		Arr:      arr,
+		Mapp:     m,
+		Typed:    typed_map,
+	}
+
+	packed, err := msgpack.Pack(object)
+	if err != nil {
+		fmt.Println(err)
+	}
+	fmt.Printf("Packed: %+v\n", packed)
+
+	var obj msgpack.Object
+	unpacked, err := msgpack.Unpack(packed, &obj)
+	if err != nil {
+		fmt.Println(err)
+	}
+	unpacked_val := unpacked.(map[any]any)
+	fmt.Printf("Unpacked: %+v\n", unpacked_val["Typed"])
+
+	fmt.Printf("object: %+v\n", obj)
+
+	bytes := make([]float32, 3)
+	bytes[0] = 1.1
+	bytes[1] = 2.2
+	bytes[2] = 3.3
+
+	ser := msgpack.Serialize(bytes)
+	fmt.Printf("Serialized: %+v\n", ser)
+
+	des := msgpack.Deserialize(ser)
+	fmt.Printf("Deserialized: %+v\n", des)
+
+}

go.mod

@@ -0,0 +1,3 @@
+module github.com/codescalersinternships/Msgpack-Fatma-Ebrahim
+
+go 1.25.1