Version 1.1.0

2024-09-25 12:04:29 +02:00

Owner

Version 1.1.0
I have been using Bofa a bit for my personal projects and found some potential changes to make for an upcoming 1.1.0 version.
This issues lists off all of the changes to make for this new version to be completed.

Pkkg support
Serialization
Types
Documentation

Serialization

Serialization still has a few things that need to be done to make it useable by others

Deserialize(Dictionary<String, Bofa>)
Currently files are parsed into a loose dictionary instead of an object.
This is a nicer representation but breaks when someone wants to store only one object inside of a single file.
They need to make a useless container object or cant take advantage of our parser generation.
Allowing our generated parser to take in a Dictionary instead of an object will fix this.
RequiredAttribute
If a single field of a file cannot be parsed we automatically fail.
This means that people who want optional fields need to write their own parser which is bad.
The required attribute indicates that the field needs to be filled by the object in order to not error.
Also the parser should no longer error when its unable to parse a field.
Strict
Returns the old behaviour of failing when a single field cannot be filled.

Types

rgb -> 3x8bit color value
Should be represented by a uint8[3] in order to map to c type structs better
rgba -> 4x8bit color value with alpha
Should be represented by a uint8[4] in order to map to c type structs better
hash -> sha256 in hexadecimal representation

Documentation

Remove finished suggestions from list of suggestions
Add Documentation for serialization features

**Version 1.1.0** I have been using Bofa a bit for my personal projects and found some potential changes to make for an upcoming 1.1.0 version. This issues lists off all of the changes to make for this new version to be completed. - [x] Pkkg support - [x] Serialization - [x] Types - [x] Documentation ## Serialization _Serialization still has a few things that need to be done to make it useable by others_ - [x] Deserialize(Dictionary<String, Bofa>) _Currently files are parsed into a loose dictionary instead of an object. This is a nicer representation but breaks when someone wants to store only one object inside of a single file. They need to make a useless container object or cant take advantage of our parser generation. Allowing our generated parser to take in a Dictionary instead of an object will fix this._ - [x] RequiredAttribute _If a single field of a file cannot be parsed we automatically fail. This means that people who want optional fields need to write their own parser which is bad. The required attribute indicates that the field needs to be filled by the object in order to not error. Also the parser should no longer error when its unable to parse a field._ - [x] Strict _Returns the old behaviour of failing when a single field cannot be filled._ ________________________________________________ ## Types - [x] rgb -> _3x8bit color value_ _Should be represented by a uint8[3] in order to map to c type structs better_ - [x] rgba -> _4x8bit color value with alpha_ _Should be represented by a uint8[4] in order to map to c type structs better_ - [x] hash -> _sha256 in hexadecimal representation_ ________________________________________________ ## Documentation - [x] Remove finished suggestions from list of suggestions - [x] Add Documentation for serialization features