PrevUpHomeNext

decoder.ready()

Fas Xmut

Distributed under the Boost Software License, Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)


decoder.ready is a method the class azvzl::az_decoder object. It is used to check if the decoded data and data size is OK of the previously calling decoder.decode(...) .

bool ready = decoder.ready();

Reason: to check if the decoded data is OK nor not, it commonly requires to check enum status, output pointers, and output size, which makes it very verbose, decoder.ready() is a final method to check if all of OK conditions are met or not.

Note: The returned enum status is OK can not make sure the result is OK, it is just an error code. decoder.ready() is the final method to check if it is OK for all. The enum status can be used to get a hint of why error occurs.

decoder.ready() can be used for both decoder.decode(...) (overload-1) and (overload-2). (Read decoder.decode(...))

Back

Up

Deck

Azvzl c++ library


PrevUpHomeNext