You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Both serde_json and serde_cbor have very nice top-level documentation for their crate, showing all the common usage modes. In comparison, ciborium says at the top level:
You’re probably looking for from_reader() and into_writer(), which are the main functions. Note that byte slices are also readers and writers and can be passed to these functions just as streams can.
For dynamic CBOR value creation/inspection, see Value.
There are no examples on what all that trait is implemented on, or in general common ways to use the library.
I believe a similar top-level documentation to serde_json and serde_cbor should also be written for ciborium and I believe it could boost the usage of the crate.
Acceptance Criteria
No response
Suggestions for a technical implementation
I may be able to provide a pull for this, if I get encouragement to do so.
The text was updated successfully, but these errors were encountered:
Is there an existing issue for this?
Description
Both
serde_json
andserde_cbor
have very nice top-level documentation for their crate, showing all the common usage modes. In comparison,ciborium
says at the top level:And then peeking into
from_reader
shows just:There are no examples on what all that trait is implemented on, or in general common ways to use the library.
I believe a similar top-level documentation to
serde_json
andserde_cbor
should also be written forciborium
and I believe it could boost the usage of the crate.Acceptance Criteria
No response
Suggestions for a technical implementation
I may be able to provide a pull for this, if I get encouragement to do so.
The text was updated successfully, but these errors were encountered: