Skip to content

Commit

Permalink
Add important block
Browse files Browse the repository at this point in the history
  • Loading branch information
Fatal1ty committed Nov 19, 2023
1 parent 7ea5de8 commit 6976c63
Showing 1 changed file with 11 additions and 6 deletions.
17 changes: 11 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -380,12 +380,17 @@ This library has built-in support for multiple popular formats:
* [TOML](https://toml.io)
* [MessagePack](https://msgpack.org)

There are preconfigured codecs and mixin classes. As for codecs, you are
offered to choose between convenience and efficiency. When you need to decode
or encode structured data more than once, it's preferable to create a decoder
or encoder specifically for that structure. For one-time use with default
settings it may be convenient to use global functions that create a disposable
decoder or encoder under the hood.
There are preconfigured codecs and mixin classes. However, you're free
to override some settings if necessary.

> [!IMPORTANT]\
> As for codecs, you are
> offered to choose between convenience and efficiency. When you need to decode
> or encode structured data more than once, it's highly recommended to create
> a decoder or encoder specifically for that structure. For one-time use with
> default settings it may be convenient to use global functions that create
> a disposable decoder or encoder under the hood. Be aware not to use these
> convenient global functions in performance-critical code!
### Basic form

Expand Down

0 comments on commit 6976c63

Please sign in to comment.