aboutsummaryrefslogtreecommitdiffstats
path: root/nihav-core/src/codecs/mod.rs
diff options
context:
space:
mode:
authorKostya Shishkov <kostya.shishkov@gmail.com>2024-04-23 18:50:29 +0200
committerKostya Shishkov <kostya.shishkov@gmail.com>2024-04-23 18:50:29 +0200
commit649cacccb6019eb40cfac6befade1ec0700fad88 (patch)
tree4beb6f8dace1c09e3e92fab062073efd063ab9dc /nihav-core/src/codecs/mod.rs
parent1b56382ecc132f9a414486cad4ac9f75241955fb (diff)
downloadnihav-649cacccb6019eb40cfac6befade1ec0700fad88.tar.gz
core: update NAPacketiser::parse_stream() documentation
Diffstat (limited to 'nihav-core/src/codecs/mod.rs')
-rw-r--r--nihav-core/src/codecs/mod.rs4
1 files changed, 3 insertions, 1 deletions
diff --git a/nihav-core/src/codecs/mod.rs b/nihav-core/src/codecs/mod.rs
index b7d7819..80e2da8 100644
--- a/nihav-core/src/codecs/mod.rs
+++ b/nihav-core/src/codecs/mod.rs
@@ -437,10 +437,12 @@ pub trait NAPacketiser {
fn add_data(&mut self, src: &[u8]) -> bool;
/// Tries to retrieve stream information from the data.
///
- /// Returns [`NAStream`] reference on success (with stream ID set to `id`), [`ShortData`] when there is not enough data to parse the headers and other errors in case there was an error parsing the data.
+ /// Returns [`NAStream`] reference on success (with stream ID set to `id`), [`ShortData`] when there is not enough data to parse the headers, [`MissingReference`] when stream parsing is not possible without reference information provided by [`attach_stream`] and other errors in case there was an error parsing the data.
///
/// [`NAStream`]: ../frame/struct.NAStream.html
/// [`ShortData`]: ./enum.DecoderError.html#variant.ShortData
+ /// [`MissingReference`]: ./enum.DecoderError.html#variant.MissingReference
+ /// [`attach_stream`]: ./trait.NAPacketiser.html#tymethod.attach_stream
fn parse_stream(&mut self, id: u32) -> DecoderResult<NAStreamRef>;
/// Tries to discard junk data until the first possible packet header.
///