§tiro/def.h

Contains basic type and macro definitions. More...

§Classes

Name
structtiro_string
Represents a string that is not necessarily zero terminated.

§Types

Name
typedef struct tiro_error *tiro_error_t
typedef struct tiro_vm *tiro_vm_t
typedef struct tiro_compiler *tiro_compiler_t
typedef struct tiro_module *tiro_module_t
typedef struct tiro_value *tiro_handle_t
typedef struct tiro_sync_frame *tiro_sync_frame_t
typedef struct tiro_async_frame *tiro_async_frame_t
typedef struct tiro_async_token *tiro_async_token_t
typedef struct tiro_resumable_frame *tiro_resumable_frame_t
typedef struct tiro_stringtiro_string_t
Represents a string that is not necessarily zero terminated.

§Functions

Name
tiro_string_ttiro_cstr(const char * data)
Helper function to construct a tiro_string_t from a zero terminated string.

§Defines

Name
TIRO_API
TIRO_WARN_UNUSED

§Detailed Description

Contains basic type and macro definitions.

This file is included by all other api headers.

§Types Documentation

§typedef tiro_error_t

typedef struct tiro_error* tiro_error_t;

§typedef tiro_vm_t

typedef struct tiro_vm* tiro_vm_t;

§typedef tiro_compiler_t

typedef struct tiro_compiler* tiro_compiler_t;

§typedef tiro_module_t

typedef struct tiro_module* tiro_module_t;

§typedef tiro_handle_t

typedef struct tiro_value* tiro_handle_t;

§typedef tiro_sync_frame_t

typedef struct tiro_sync_frame* tiro_sync_frame_t;

§typedef tiro_async_frame_t

typedef struct tiro_async_frame* tiro_async_frame_t;

§typedef tiro_async_token_t

typedef struct tiro_async_token* tiro_async_token_t;

§typedef tiro_resumable_frame_t

typedef struct tiro_resumable_frame* tiro_resumable_frame_t;

§typedef tiro_string_t

typedef struct tiro_string tiro_string_t;

Represents a string that is not necessarily zero terminated.

data must have length readable bytes. data is allowed to be NULL (or any other invalid pointer) if and only if length is 0.

§Functions Documentation

§function tiro_cstr

inline tiro_string_t tiro_cstr(
const char * data
)

Helper function to construct a tiro_string_t from a zero terminated string.

Parameters:

  • data a zero terminated string, or NULL.

Internally calls strlen on non-NULL inputs to determine their length.

§Macros Documentation

§define TIRO_API

#define TIRO_API

§define TIRO_WARN_UNUSED

#define TIRO_WARN_UNUSED

Updated on 2022-02-27 at 21:17:13 +0100