2.1.1 Attributes — Zix 0.4.2 documentation

# 2.1.1 Attributes

ZIX_BEGIN_DECLS

  Begin public API definitions.

ZIX_END_DECLS

  End public API definitions.

ZIX_ALWAYS_INLINE_FUNC

  Should absolutely always be inlined.

ZIX_PURE_FUNC

  Only reads memory.

ZIX_CONST_FUNC

  Only reads its parameters.

ZIX_MALLOC_FUNC

  Allocates memory.

ZIX_PURE_API

  A pure function in the public API that only reads memory.

ZIX_CONST_API

  A const function in the public API that is pure and only reads parameters.

ZIX_MALLOC_API

  A malloc function in the public API that returns allocated memory.

ZIX_LOG_FUNC(fmt, arg1)

  A function with printf-like parameters.

ZIX_UNUSED(name)

  An unused parameter.

ZIX_NONNULL

  A non-null pointer.

ZIX_NULLABLE

  A nullable pointer.

ZIX_ALLOCATED

  An allocated (possibly null) pointer.

ZIX_UNSPECIFIED

  A pointer with unspecified nullability.