add example about compression #2623
Conversation
|
Thanks! This is a useful example. Can you show how much overhead is generated by working with and without compression? |
Do you mean showing the difference in bytes? in cpu resource? in memory? |
|
I could also add some tests. Other examples do not have tests in general, so I don't know if it's something we should do or not. |
|
Yes, of course, this is not a necessity. Just my wondering - is this feature useful or expensive. Any tests. |
I don't have any scientific tests. And the results depend a lot on the kind of data you're compressing. |
|
I've added tests about compression and decompression. |
examples/compression/src/main.rs
Outdated
| async fn root(Json(value): Json<Value>) -> Json<Value> { | ||
| Json(value) | ||
| } | ||
|
|
There was a problem hiding this comment.
Can you add a visual delimiter here like // ===== TESTS ===== so that it is clearer for the reader that anything bellow is superfluous for the example they were looking for?
There was a problem hiding this comment.
Do we have a marker like that elsewhere? Seems a bit weird to me honestly.
There was a problem hiding this comment.
I don't think so, but we also don't have tests in examples so there really never was a need.
But personally, when I skimmed through the code, I suddenly found myself between the #[test] decorated functions and it wasn't as easy for me to visually find where the code ends and the tests begin since.
But I don't mind if you don't like this and you'd rather just have it as it was.
There was a problem hiding this comment.
I could also move the tests to a separated test.rs. WDYT?
examples/compression/src/main.rs
Outdated
| async fn root(Json(value): Json<Value>) -> Json<Value> { | ||
| Json(value) | ||
| } | ||
|
|
There was a problem hiding this comment.
Do we have a marker like that elsewhere? Seems a bit weird to me honestly.
Co-authored-by: Jonas Platte <jplatte+git@posteo.de>
Motivation
When I wanted to decompress request bodies, I had some difficulties finding the right way to do it.
Solution
Having an example could help others finding a way to use compression and decompression quickly.