core/codecs: introduce a special error for failed checksum

[nihav.git] / nihav-core / src / codecs / mod.rs

diff --git a/nihav-core/src/codecs/mod.rs b/nihav-core/src/codecs/mod.rs
index c6ee95ec71a844043d449af5b3e6ade48e7dc5ba..2ae0c334766a0806bf281eb607fe50560b63d1cd 100644 (file)
--- a/nihav-core/src/codecs/mod.rs
+++ b/nihav-core/src/codecs/mod.rs
@@ -18,6 +18,8 @@ pub enum DecoderError {
     TryAgain,
     /// Invalid input data was provided.
     InvalidData,
+    /// Checksum verification failed.
+    ChecksumError,
     /// Provided input turned out to be incomplete.
     ShortData,
     /// Decoder could not decode provided frame because it references some missing previous frame.
@@ -102,7 +104,7 @@ pub struct DecoderInfo {
 
 /// Structure for registering known decoders.
 ///
-/// It is supposed to be filled using `register_all_codecs()` from some decoders crate and then it can be used to create decoders for the requested codecs.
+/// It is supposed to be filled using `register_all_decoders()` from some decoders crate and then it can be used to create decoders for the requested codecs.
 #[derive(Default)]
 pub struct RegisteredDecoders {
     decs:   Vec<DecoderInfo>,
@@ -263,7 +265,7 @@ impl Default for EncodeParameters {
 /// while let Some(frame) = queue.get_frame() {
 ///     // convert to the format encoder expects if required
 ///     encoder.encode(frame)?;
-///     while let Some(enc_pkt) = encoder.get_packet()? {
+///     while let Ok(enc_pkt) = encoder.get_packet()? {
 ///         // send encoded packet to a muxer for example
 ///     }
 /// }
@@ -319,7 +321,7 @@ pub struct EncoderInfo {
 
 /// Structure for registering known encoders.
 ///
-/// It is supposed to be filled using `register_all_codecs()` from some encoders crate and then it can be used to create encoders for the requested codecs.
+/// It is supposed to be filled using `register_all_decoders()` from some encoders crate and then it can be used to create encoders for the requested codecs.
 #[derive(Default)]
 pub struct RegisteredEncoders {
     encs:   Vec<EncoderInfo>,