Skip to content

Commit

Permalink
better doc for FrameDecoder
Browse files Browse the repository at this point in the history
  • Loading branch information
KillingSpark committed Dec 21, 2024
1 parent 5c547f0 commit 2cec9cf
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion src/decoding/frame_decoder.rs
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ use alloc::collections::BTreeMap;
use alloc::vec::Vec;
use core::convert::TryInto;

/// This implements a decoder for zstd frames.
/// Low level Zstandard decoder that can be used to decompress frames with fine control over when and how many bytes are decoded.
///
/// This decoder is able to decode frames only partially and gives control
/// over how many bytes/blocks will be decoded at a time (so you don't have to decode a 10GB file into memory all at once).
Expand Down

0 comments on commit 2cec9cf

Please sign in to comment.