Skip to content

Commit

Permalink
Add docs for rewind_reader_and_verify_encoding_type.
Browse files Browse the repository at this point in the history
  • Loading branch information
junhaoliao committed Oct 15, 2024
1 parent ab32045 commit 15d818c
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions src/clp_ffi_js/ir/decoding_methods.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,12 @@
#include <clp/ReaderInterface.hpp>

namespace clp_ffi_js::ir {
/**
* Rewinds the reader to the beginning and verifies the CLP IR data encoding type.
* @param reader
* @throws ClpFfiJsException if there is a failure to decode the encoding type or if the encoding
* type is unsupported.
*/
auto rewind_reader_and_verify_encoding_type(clp::ReaderInterface& reader) -> void;
} // namespace clp_ffi_js::ir

Expand Down

0 comments on commit 15d818c

Please sign in to comment.