maix::err

maix.err module

This is maix::err module of MaixCDK.
All of these elements are in namespace maix::err.

For MaixCDK developer: DO NOT edit this doc file manually, this doc is auto generated!

Module

No module

Enum

Err

Maix Error code

C++ defination code:

enum Err
    {
        // !!! fixed error code, DO NOT change number already defined, only append new error code
        ERR_NONE        = 0,   // No error
        ERR_ARGS           ,   // Invalid arguments
        ERR_NO_MEM         ,   // No memory
        ERR_NOT_IMPL       ,   // Not implemented
        ERR_NOT_READY      ,   // Not ready
        ERR_NOT_INIT       ,   // Not initialized
        ERR_NOT_OPEN       ,   // Not opened
        ERR_NOT_PERMIT     ,   // Not permitted
        ERR_REOPEN         ,   // Re-open
        ERR_BUSY           ,   // Busy
        ERR_READ           ,   // Read error
        ERR_WRITE          ,   // Write error
        ERR_TIMEOUT        ,   // Timeout
        ERR_RUNTIME        ,   // Runtime error
        ERR_IO             ,   // IO error
        ERR_NOT_FOUND      ,   // Not found
        ERR_ALREAY_EXIST   ,   // Already exist
        ERR_BUFF_FULL      ,   // Buffer full
        ERR_BUFF_EMPTY     ,   // Buffer empty
        ERR_CANCEL         ,   // Cancel
        ERR_OVERFLOW       ,   // Overflow
        ERR_MAX,
    }

Variable

Function

to_str

Error code to string

C++ defination code:

std::string to_str(err::Err e)

get_error

get last error string

C++ defination code:

std::string& get_error()

set_error

set last error string

C++ defination code:

void set_error(const std::string &str)

check_raise

Check error code, if not ERR_NONE, raise err.Exception

C++ defination code:

void check_raise(err::Err e, const std::string &msg = "")

check_bool_raise

Check condition, if false, raise err.Exception

C++ defination code:

void check_bool_raise(bool ok, const std::string &msg = "")

check_null_raise

Check NULL pointer, if NULL, raise exception

C++ defination code:

void check_null_raise(void *ptr, const std::string &msg = "")

Class

Exception

Maix Exception

C++ defination code:

class Exception : public std::exception