From: Kostya Shishkov Date: Tue, 23 Apr 2024 16:50:29 +0000 (+0200) Subject: core: update NAPacketiser::parse_stream() documentation X-Git-Url: https://git.nihav.org/?p=nihav.git;a=commitdiff_plain;h=649cacccb6019eb40cfac6befade1ec0700fad88 core: update NAPacketiser::parse_stream() documentation --- 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; /// Tries to discard junk data until the first possible packet header. ///