Document the "logging" feature (was "Debugging faciility")

[vext01]

Document the "logging" feature (was "Debugging faciility")

[wcampbell0x2a]

(Off-topic: I also note that you are doing benchmarking in that PR -- Good! Because I had wondered how quick deku was to parse compared to a manually written parser. It might be good to say a few words about performance somewhere in your docs/README, and if you have performance numbers, possibly show those too? The things I have been parsing haven't required bitwise granularity (I always read whole bytes), and I wonder if I'm paying for that in terms of performance?)

Currently right now, you suffer a small amount of performance due to the use of BitVec( a really small amount in the grand scheme of most program runtimes). But when all the MR's are merged we will stay the same as just writing your own ( I have some benchmarks that I haven't uploaded that will track that).

[vext01]

I've just found the logging feature.

It somewhat helps, but it would be better if it could print the result of parsing each sub-object, instead of what will be parsed (and a bit bag of bits).

[wcampbell0x2a]

Sorry that isn't documented, I hope to document that feature better in the future.

One thing to note is that logging is improved by this MR: #352.

I'll make sure to add the value that was decoded. I've wanted that also when debugging my decoders.

[vext01]

Thanks so much, and thanks again for Deku. I think it's neat!

[vext01]

(Off-topic: I also note that you are doing benchmarking in that PR -- Good! Because I had wondered how quick deku was to parse compared to a manually written parser. It might be good to say a few words about performance somewhere in your docs/README, and if you have performance numbers, possibly show those too? The things I have been parsing haven't required bitwise granularity (I always read whole bytes), and I wonder if I'm paying for that in terms of performance?)

[vext01]

I've just tried the improved logging from #352

Much better! I hope if gets merged very soon!

[vext01]

I also realised that logging isn't documented. I will raise a PR soonish.