Green-Sky/tomato
Green-Sky/tomato
1
0
Fork 1
Code Issues Pull Requests 1 Actions Packages Projects Releases 1 Wiki Activity

update fs readme a little

Browse Source
This commit is contained in:
Green Sky 2024-02-18 13:25:15 +01:00
parent 6f511016bc
commit 182d844e32
No known key found for this signature in database
1 changed files with 8 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
src/fragment_store/README.md
View File

@ -25,17 +25,16 @@ Just keeps the Fragments in memory.
# File formats # File formats
Files can be compressed and encrypted. Since compression needs the data structure to funcion, it is applied before it is encrypted. Files can be compressed and encrypted. Since compression needs the data's structure to work properly, it is applied before it is encrypted.
### Text Json ### Text Json
Text json only makes sense for metadata if it's neither compressed nor encrypted. (otherwise its binary on disk anyway, so why waste bytes). Text json only makes sense for metadata if it's neither compressed nor encrypted. (otherwise its binary on disk anyway, so why waste bytes).
Since the content of data is not looked at, nothing stops you from using text json and ecrypt it, but atleast basic compression is advised. Since the content of data is not looked at, nothing stops you from using text json and ecrypt it, but atleast basic compression is advised.
A Metadata json object has the following keys: A Metadata json object can have arbitrary keys, some are predefined:
- `enc` (uint) Encryption type of the data, if any - `FragComp::DataEncryptionType` (uint) Encryption type of the data, if any
- `comp` (uint) Compression type of the data, if any - `FragComp::DataCompressionType` (uint) Compression type of the data, if any
- `metadata` (obj) the
## Binary file headers ## Binary file headers
@ -70,3 +69,7 @@ file magic bytes `SOLFIL` (6 bytes)
...data here... ...data here...
## Compression types
- `0x00` none
- `0x01` zstd (without dict)