Skip to content

Commit

Permalink
filter/Filter: clarify Flush() documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
MaxKellermann committed Nov 5, 2024
1 parent d7ae512 commit d619502
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions src/filter/Filter.hxx
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,13 @@ public:
* Flush pending data and return it. This should be called
* repeatedly until it returns nullptr.
*
* After calling this method, this object cannot be used again
* (not even Reset() is allowed).
*
* Throws on error.
*
* @return pending data (will be invalidated by deleting this
* object or by any call to Flush())
*/
virtual std::span<const std::byte> Flush() {
return {};
Expand Down

0 comments on commit d619502

Please sign in to comment.