2 Zix C API

• 2.1 Utilities
  • 2.1.1 Attributes
    • ZIX_ALLOCATED
    • ZIX_ALLOC_COUNT_SIZE()
    • ZIX_ALLOC_SIZE()
    • ZIX_ALWAYS_INLINE_FUNC
    • ZIX_CONST_FUNC
    • ZIX_LOG_FUNC()
    • ZIX_MALLOC_FUNC
    • ZIX_NODISCARD
    • ZIX_NONBLOCKING
    • ZIX_NONNULL
    • ZIX_NULLABLE
    • ZIX_PURE_FUNC
    • ZIX_REALTIME
    • ZIX_UNSPECIFIED
    • ZIX_UNUSED()
  • 2.1.2 Status Codes
    • ZixStatus
      • ZIX_STATUS_SUCCESS
      • ZIX_STATUS_ERROR
      • ZIX_STATUS_NO_MEM
      • ZIX_STATUS_NOT_FOUND
      • ZIX_STATUS_EXISTS
      • ZIX_STATUS_BAD_ARG
      • ZIX_STATUS_BAD_PERMS
      • ZIX_STATUS_REACHED_END
      • ZIX_STATUS_TIMEOUT
      • ZIX_STATUS_OVERFLOW
      • ZIX_STATUS_NOT_SUPPORTED
      • ZIX_STATUS_UNAVAILABLE
      • ZIX_STATUS_NO_SPACE
      • ZIX_STATUS_MAX_LINKS
    • zix_strerror()
  • 2.1.3 String View
    • ZIX_STATIC_STRING()
    • ZixStringView
      • data
      • length
    • zix_empty_string()
    • zix_string()
    • zix_string_view_copy()
    • zix_string_view_equals()
    • zix_substring()
• 2.2 Allocation
  • 2.2.1 Allocator
    • ZixAlignedAllocFunc
    • ZixAlignedFreeFunc
    • ZixAllocator
    • ZixCallocFunc
    • ZixFreeFunc
    • ZixMallocFunc
    • ZixReallocFunc
    • ZixAllocatorImpl
      • malloc
      • calloc
      • realloc
      • free
      • aligned_alloc
      • aligned_free
    • zix_aligned_alloc()
    • zix_aligned_free()
    • zix_calloc()
    • zix_default_allocator()
    • zix_free()
    • zix_malloc()
    • zix_realloc()
  • 2.2.2 Bump Allocator
    • ZixBumpAllocator
      • base
      • buffer
      • last
      • top
      • capacity
    • zix_bump_allocator()
• 2.3 Algorithms
  • 2.3.1 Digest
    • zix_digest()
    • zix_digest32()
    • zix_digest32_aligned()
    • zix_digest64()
    • zix_digest64_aligned()
    • zix_digest_aligned()
• 2.4 Data Structures
  • 2.4.1 BTree
    • 2.4.1.1 Types
      • ZIX_BTREE_MAX_HEIGHT
      • ZixBTree
      • ZixBTreeCompareFunc
      • ZixBTreeDestroyFunc
    • 2.4.1.2 Setup
      • zix_btree_clear()
      • zix_btree_free()
      • zix_btree_new()
      • zix_btree_size()
    • 2.4.1.3 Iteration
      • ZixBTreeNode
      • ZixBTreeIter
        • nodes
        • indexes
        • level
      • zix_btree_begin()
      • zix_btree_end()
      • zix_btree_end_iter
      • zix_btree_get()
      • zix_btree_iter_equals()
      • zix_btree_iter_increment()
      • zix_btree_iter_is_end()
      • zix_btree_iter_next()
    • 2.4.1.4 Modification
      • zix_btree_insert()
      • zix_btree_remove()
    • 2.4.1.5 Searching
      • zix_btree_find()
      • zix_btree_lower_bound()
  • 2.4.2 Hash
    • 2.4.2.1 Types
      • ZixHash
      • ZixHashCode
      • ZixHashFunc
      • ZixHashKey
      • ZixHashRecord
      • ZixHashSearchData
      • ZixKeyEqualFunc
      • ZixKeyFunc
    • 2.4.2.2 Setup
      • zix_hash_free()
      • zix_hash_new()
      • zix_hash_size()
    • 2.4.2.3 Iteration
      • ZixHashIter
      • zix_hash_begin()
      • zix_hash_end()
      • zix_hash_get()
      • zix_hash_next()
    • 2.4.2.4 Modification
      • ZixKeyMatchFunc
      • ZixHashInsertPlan
        • code
        • index
      • zix_hash_erase()
      • zix_hash_insert()
      • zix_hash_insert_at()
      • zix_hash_plan_insert()
      • zix_hash_plan_insert_prehashed()
      • zix_hash_record_at()
      • zix_hash_remove()
    • 2.4.2.5 Searching
      • zix_hash_find()
      • zix_hash_find_record()
  • 2.4.3 Ring
    • 2.4.3.1 Types
      • ZixRing
    • 2.4.3.2 Setup
      • zix_ring_capacity()
      • zix_ring_free()
      • zix_ring_mlock()
      • zix_ring_new()
      • zix_ring_reset()
    • 2.4.3.3 Reading
      • zix_ring_peek()
      • zix_ring_read()
      • zix_ring_read_space()
      • zix_ring_skip()
    • 2.4.3.4 Writing
      • ZixRingTransaction
        • read_head
        • write_head
      • zix_ring_amend_write()
      • zix_ring_begin_write()
      • zix_ring_commit_write()
      • zix_ring_write()
      • zix_ring_write_space()
  • 2.4.4 Tree
    • 2.4.4.1 Types
      • ZixTree
      • ZixTreeCompareFunc
      • ZixTreeDestroyFunc
    • 2.4.4.2 Setup
      • zix_tree_free()
      • zix_tree_new()
      • zix_tree_size()
    • 2.4.4.3 Iteration
      • ZixTreeIter
      • zix_tree_begin()
      • zix_tree_end()
      • zix_tree_get()
      • zix_tree_iter_is_end()
      • zix_tree_iter_is_rend()
      • zix_tree_iter_next()
      • zix_tree_iter_prev()
      • zix_tree_rbegin()
      • zix_tree_rend()
    • 2.4.4.4 Modification
      • zix_tree_insert()
      • zix_tree_remove()
    • 2.4.4.5 Searching
      • zix_tree_find()
• 2.5 Threading
  • 2.5.1 Semaphore
    • ZixSem
    • zix_sem_destroy()
    • zix_sem_init()
    • zix_sem_post()
    • zix_sem_timed_wait()
    • zix_sem_try_wait()
    • zix_sem_wait()
  • 2.5.2 Thread
    • ZIX_THREAD_FUNC
    • ZIX_THREAD_RESULT
    • ZixThread
    • ZixThreadFunc
    • ZixThreadResult
    • zix_thread_create()
    • zix_thread_join()
• 2.6 File System
  • 2.6.1 Operations
    • 2.6.1.1 Creation and Removal
      • ZixCopyOptions
      • ZixCopyOption
        • ZIX_COPY_OPTION_NONE
        • ZIX_COPY_OPTION_OVERWRITE_EXISTING
      • zix_copy_file()
      • zix_create_directories()
      • zix_create_directory()
      • zix_create_directory_like()
      • zix_create_directory_symlink()
      • zix_create_hard_link()
      • zix_create_symlink()
      • zix_create_temporary_directory()
      • zix_remove()
    • 2.6.1.2 Access
      • ZixDirEntryVisitFunc
      • zix_dir_for_each()
      • zix_file_equals()
    • 2.6.1.3 Resolution
      • zix_canonical_path()
    • 2.6.1.4 Locking
      • ZixFileLockMode
        • ZIX_FILE_LOCK_BLOCK
        • ZIX_FILE_LOCK_TRY
      • zix_file_lock()
      • zix_file_unlock()
    • 2.6.1.5 Queries
      • ZixFileOffset
      • ZixFileType
        • ZIX_FILE_TYPE_NONE
        • ZIX_FILE_TYPE_REGULAR
        • ZIX_FILE_TYPE_DIRECTORY
        • ZIX_FILE_TYPE_SYMLINK
        • ZIX_FILE_TYPE_BLOCK
        • ZIX_FILE_TYPE_CHARACTER
        • ZIX_FILE_TYPE_FIFO
        • ZIX_FILE_TYPE_SOCKET
        • ZIX_FILE_TYPE_UNKNOWN
      • zix_file_size()
      • zix_file_type()
      • zix_symlink_type()
    • 2.6.1.6 Environment
      • zix_current_path()
      • zix_temp_directory_path()
  • 2.6.2 Paths
    • 2.6.2.1 Concatenation
      • zix_path_join()
    • 2.6.2.2 Lexical Transformations
      • zix_path_lexically_normal()
      • zix_path_lexically_relative()
      • zix_path_preferred()
    • 2.6.2.3 Decomposition
      • zix_path_extension()
      • zix_path_filename()
      • zix_path_parent_path()
      • zix_path_relative_path()
      • zix_path_root_directory()
      • zix_path_root_name()
      • zix_path_root_path()
      • zix_path_stem()
    • 2.6.2.4 Queries
      • zix_path_has_extension()
      • zix_path_has_filename()
      • zix_path_has_parent_path()
      • zix_path_has_relative_path()
      • zix_path_has_root_directory()
      • zix_path_has_root_name()
      • zix_path_has_root_path()
      • zix_path_has_stem()
      • zix_path_is_absolute()
      • zix_path_is_relative()
• 2.7 Environment
  • 2.7.1 Variable Expansion
    • zix_expand_environment_strings()