diff options
author | mvel <mvel@yandex-team.ru> | 2022-02-10 16:45:41 +0300 |
---|---|---|
committer | Daniil Cherednik <dcherednik@yandex-team.ru> | 2022-02-10 16:45:41 +0300 |
commit | 43f5a35593ebc9f6bcea619bb170394ea7ae468e (patch) | |
tree | e98df59de24d2ef7c77baed9f41e4875a2fef972 /library/cpp/blockcodecs/README.md | |
parent | bd30392c4cc92487950adc375c07adf52da1d592 (diff) | |
download | ydb-43f5a35593ebc9f6bcea619bb170394ea7ae468e.tar.gz |
Restoring authorship annotation for <mvel@yandex-team.ru>. Commit 2 of 2.
Diffstat (limited to 'library/cpp/blockcodecs/README.md')
-rw-r--r-- | library/cpp/blockcodecs/README.md | 32 |
1 files changed, 16 insertions, 16 deletions
diff --git a/library/cpp/blockcodecs/README.md b/library/cpp/blockcodecs/README.md index b8e9bf16dc..417917a475 100644 --- a/library/cpp/blockcodecs/README.md +++ b/library/cpp/blockcodecs/README.md @@ -1,20 +1,20 @@ -This is a simple library for block data compression (this means data is compressed/uncompressed +This is a simple library for block data compression (this means data is compressed/uncompressed by whole blocks in memory). It's a lite-version of the `library/cpp/codecs`. Lite here means that it -provide only well-known compression algorithms, without the possibility of learning. - -There are two possible ways to work with it. - -Codec by name -============= -Use `NBlockCodec::Codec` to obtain the codec by name. The codec can be asked to compress -or decompress something and in various ways. - -To get a full list of codecs there is a function `NBlockCodecs::ListAllCodecs()`. - -Streaming -========= -Use `stream.h` to obtain simple streams over block codecs (buffer data, compress them by blocks, -write to the resulting stream). +provide only well-known compression algorithms, without the possibility of learning. + +There are two possible ways to work with it. + +Codec by name +============= +Use `NBlockCodec::Codec` to obtain the codec by name. The codec can be asked to compress +or decompress something and in various ways. + +To get a full list of codecs there is a function `NBlockCodecs::ListAllCodecs()`. + +Streaming +========= +Use `stream.h` to obtain simple streams over block codecs (buffer data, compress them by blocks, +write to the resulting stream). Using codec plugins =================== |