# API Reference

## API Index

### A

OstreeAsyncProgress, typedef in Progress notification system for asynchronous operations
ostree_async_progress_finish, function in Progress notification system for asynchronous operations
ostree_async_progress_get, function in Progress notification system for asynchronous operations
ostree_async_progress_get_status, function in Progress notification system for asynchronous operations
ostree_async_progress_get_uint, function in Progress notification system for asynchronous operations
ostree_async_progress_get_uint64, function in Progress notification system for asynchronous operations
ostree_async_progress_get_variant, function in Progress notification system for asynchronous operations
ostree_async_progress_new, function in Progress notification system for asynchronous operations
ostree_async_progress_new_and_connect, function in Progress notification system for asynchronous operations
ostree_async_progress_set, function in Progress notification system for asynchronous operations
ostree_async_progress_set_status, function in Progress notification system for asynchronous operations
ostree_async_progress_set_uint, function in Progress notification system for asynchronous operations
ostree_async_progress_set_uint64, function in Progress notification system for asynchronous operations
ostree_async_progress_set_variant, function in Progress notification system for asynchronous operations

### B

OstreeBootconfigParser, struct in ostree-bootconfig-parser
ostree_bootconfig_parser_clone, function in ostree-bootconfig-parser
ostree_bootconfig_parser_get, function in ostree-bootconfig-parser
ostree_bootconfig_parser_new, function in ostree-bootconfig-parser
ostree_bootconfig_parser_parse, function in ostree-bootconfig-parser
ostree_bootconfig_parser_parse_at, function in ostree-bootconfig-parser
ostree_bootconfig_parser_set, function in ostree-bootconfig-parser
ostree_bootconfig_parser_write, function in ostree-bootconfig-parser
ostree_bootconfig_parser_write_at, function in ostree-bootconfig-parser

### C

OstreeChainInputStream, struct in ostree-chain-input-stream
ostree_chain_input_stream_new, function in ostree-chain-input-stream
OstreeChecksumInputStream, struct in ostree-checksum-input-stream
ostree_checksum_b64_from_bytes, function in Core repository-independent functions
ostree_checksum_b64_inplace_from_bytes, function in Core repository-independent functions
ostree_checksum_b64_inplace_to_bytes, function in Core repository-independent functions
ostree_checksum_b64_to_bytes, function in Core repository-independent functions
ostree_checksum_bytes_peek, function in Core repository-independent functions
ostree_checksum_bytes_peek_validate, function in Core repository-independent functions
ostree_checksum_file, function in Core repository-independent functions
ostree_checksum_file_async, function in Core repository-independent functions
ostree_checksum_file_async_finish, function in Core repository-independent functions
ostree_checksum_file_from_input, function in Core repository-independent functions
ostree_checksum_from_bytes, function in Core repository-independent functions
ostree_checksum_from_bytes_v, function in Core repository-independent functions
ostree_checksum_inplace_from_bytes, function in Core repository-independent functions
ostree_checksum_inplace_to_bytes, function in Core repository-independent functions
ostree_checksum_input_stream_new, function in ostree-checksum-input-stream
ostree_checksum_to_bytes, function in Core repository-independent functions
ostree_checksum_to_bytes_v, function in Core repository-independent functions
OSTREE_CHECK_VERSION, macro in ostree-version
ostree_check_version, function in Core repository-independent functions
ostree_cmp_checksum_bytes, function in Core repository-independent functions
ostree_commit_get_parent, function in Core repository-independent functions
ostree_commit_get_timestamp, function in Core repository-independent functions
OSTREE_COMMIT_GVARIANT_FORMAT, macro in Core repository-independent functions
OSTREE_COMMIT_GVARIANT_STRING, macro in Core repository-independent functions
ostree_content_file_parse, function in Core repository-independent functions
ostree_content_file_parse_at, function in Core repository-independent functions
ostree_content_stream_parse, function in Core repository-independent functions
ostree_create_directory_metadata, function in Core repository-independent functions

### D

OstreeDeployment, struct in ostree-deployment
ostree_deployment_clone, function in ostree-deployment
ostree_deployment_equal, function in ostree-deployment
ostree_deployment_get_bootconfig, function in ostree-deployment
ostree_deployment_get_bootcsum, function in ostree-deployment
ostree_deployment_get_bootserial, function in ostree-deployment
ostree_deployment_get_csum, function in ostree-deployment
ostree_deployment_get_deployserial, function in ostree-deployment
ostree_deployment_get_index, function in ostree-deployment
ostree_deployment_get_origin, function in ostree-deployment
ostree_deployment_get_origin_relpath, function in ostree-deployment
ostree_deployment_get_osname, function in ostree-deployment
ostree_deployment_get_unlocked, function in ostree-deployment
ostree_deployment_hash, function in ostree-deployment
ostree_deployment_new, function in ostree-deployment
ostree_deployment_set_bootconfig, function in ostree-deployment
ostree_deployment_set_bootserial, function in ostree-deployment
ostree_deployment_set_index, function in ostree-deployment
ostree_deployment_set_origin, function in ostree-deployment
ostree_deployment_unlocked_state_to_string, function in ostree-deployment
OstreeDiffFlags, enum in ostree-diff
OstreeDiffItem, struct in ostree-diff
ostree_diff_dirs, function in ostree-diff
ostree_diff_dirs_with_options, function in ostree-diff
ostree_diff_item_ref, function in ostree-diff
ostree_diff_item_unref, function in ostree-diff
ostree_diff_print, function in ostree-diff
OSTREE_DIRMETA_GVARIANT_FORMAT, macro in Core repository-independent functions
OSTREE_DIRMETA_GVARIANT_STRING, macro in Core repository-independent functions

### F

OSTREE_FILEMETA_GVARIANT_FORMAT, macro in Core repository-independent functions
OSTREE_FILEMETA_GVARIANT_STRING, macro in Core repository-independent functions

### G

OstreeGpgError, enum in GPG signature verification results
OstreeGpgSignatureAttr, enum in GPG signature verification results
OstreeGpgSignatureFormatFlags, enum in GPG signature verification results
OstreeGpgVerifyResult, typedef in GPG signature verification results
ostree_gpg_verify_result_count_all, function in GPG signature verification results
ostree_gpg_verify_result_count_valid, function in GPG signature verification results
ostree_gpg_verify_result_describe, function in GPG signature verification results
ostree_gpg_verify_result_describe_variant, function in GPG signature verification results
ostree_gpg_verify_result_get, function in GPG signature verification results
ostree_gpg_verify_result_get_all, function in GPG signature verification results
ostree_gpg_verify_result_lookup, function in GPG signature verification results
ostree_gpg_verify_result_require_valid_signature, function in GPG signature verification results

### H

ostree_hash_object_name, function in Core repository-independent functions

### M

OSTREE_MAX_METADATA_SIZE, macro in Core repository-independent functions
OSTREE_MAX_METADATA_WARN_SIZE, macro in Core repository-independent functions
ostree_metadata_variant_type, function in Core repository-independent functions
OstreeMutableTree, typedef in In-memory modifiable filesystem tree
ostree_mutable_tree_ensure_dir, function in In-memory modifiable filesystem tree
ostree_mutable_tree_ensure_parent_dirs, function in In-memory modifiable filesystem tree
ostree_mutable_tree_get_contents_checksum, function in In-memory modifiable filesystem tree
ostree_mutable_tree_get_files, function in In-memory modifiable filesystem tree
ostree_mutable_tree_get_metadata_checksum, function in In-memory modifiable filesystem tree
ostree_mutable_tree_get_subdirs, function in In-memory modifiable filesystem tree
ostree_mutable_tree_lookup, function in In-memory modifiable filesystem tree
ostree_mutable_tree_new, function in In-memory modifiable filesystem tree
ostree_mutable_tree_replace_file, function in In-memory modifiable filesystem tree
ostree_mutable_tree_set_contents_checksum, function in In-memory modifiable filesystem tree
ostree_mutable_tree_set_metadata_checksum, function in In-memory modifiable filesystem tree
ostree_mutable_tree_walk, function in In-memory modifiable filesystem tree

### O

OstreeObjectType, enum in Core repository-independent functions
ostree_object_from_string, function in Core repository-independent functions
ostree_object_name_deserialize, function in Core repository-independent functions
ostree_object_name_serialize, function in Core repository-independent functions
ostree_object_to_string, function in Core repository-independent functions
ostree_object_type_from_string, function in Core repository-independent functions
OSTREE_OBJECT_TYPE_IS_META, macro in Core repository-independent functions
OSTREE_OBJECT_TYPE_LAST, macro in Core repository-independent functions
ostree_object_type_to_string, function in Core repository-independent functions

### P

ostree_parse_refspec, function in Core repository-independent functions

### R

ostree_raw_file_to_archive_z2_stream, function in Core repository-independent functions
ostree_raw_file_to_archive_z2_stream_with_options, function in Core repository-independent functions
ostree_raw_file_to_content_stream, function in Core repository-independent functions
OSTREE_RELEASE_VERSION, macro in ostree-version
OstreeRepo, typedef in OstreeRepo
OstreeRepoCheckoutMode, enum in OstreeRepo
OstreeRepoCheckoutOverwriteMode, enum in OstreeRepo
OstreeRepoCommitFilter, user_function in OstreeRepo
OstreeRepoCommitFilterResult, enum in OstreeRepo
OstreeRepoCommitIterResult, enum in OstreeRepo
OstreeRepoCommitModifier, typedef in OstreeRepo
OstreeRepoCommitModifierFlags, enum in OstreeRepo
OstreeRepoCommitModifierXattrCallback, user_function in OstreeRepo
OstreeRepoCommitState, enum in OstreeRepo
OstreeRepoCommitTraverseFlags, enum in OstreeRepo
OstreeRepoFile, typedef in ostree-repo-file
OstreeRepoListObjectsFlags, enum in OstreeRepo
OstreeRepoListRefsExtFlags, enum in OstreeRepo
OstreeRepoMode, enum in OstreeRepo
OstreeRepoPruneFlags, enum in OstreeRepo
OstreeRepoPullFlags, enum in OstreeRepo
OstreeRepoRemoteChange, enum in OstreeRepo
OstreeRepoResolveRevExtFlags, enum in OstreeRepo
OstreeRepoTransactionStats, struct in OstreeRepo
ostree_repo_abort_transaction, function in OstreeRepo
ostree_repo_add_gpg_signature_summary, function in OstreeRepo
ostree_repo_append_gpg_signature, function in OstreeRepo
ostree_repo_checkout_at, function in OstreeRepo
ostree_repo_checkout_gc, function in OstreeRepo
ostree_repo_checkout_tree, function in OstreeRepo
ostree_repo_checkout_tree_at, function in OstreeRepo
ostree_repo_commit_modifier_new, function in OstreeRepo
ostree_repo_commit_modifier_ref, function in OstreeRepo
ostree_repo_commit_modifier_set_devino_cache, function in OstreeRepo
ostree_repo_commit_modifier_set_sepolicy, function in OstreeRepo
ostree_repo_commit_modifier_set_xattr_callback, function in OstreeRepo
ostree_repo_commit_modifier_unref, function in OstreeRepo
ostree_repo_commit_transaction, function in OstreeRepo
ostree_repo_commit_traverse_iter_cleanup, function in OstreeRepo
ostree_repo_commit_traverse_iter_clear, function in OstreeRepo
ostree_repo_commit_traverse_iter_get_dir, function in OstreeRepo
ostree_repo_commit_traverse_iter_get_file, function in OstreeRepo
ostree_repo_commit_traverse_iter_init_commit, function in OstreeRepo
ostree_repo_commit_traverse_iter_init_dirtree, function in OstreeRepo
ostree_repo_commit_traverse_iter_next, function in OstreeRepo
ostree_repo_copy_config, function in OstreeRepo
ostree_repo_create, function in OstreeRepo
ostree_repo_create_at, function in OstreeRepo
ostree_repo_delete_object, function in OstreeRepo
ostree_repo_devino_cache_get_type, function in OstreeRepo
ostree_repo_devino_cache_new, function in OstreeRepo
ostree_repo_devino_cache_ref, function in OstreeRepo
ostree_repo_devino_cache_unref, function in OstreeRepo
ostree_repo_equal, function in OstreeRepo
ostree_repo_export_tree_to_archive, function in OstreeRepo
ostree_repo_file_ensure_resolved, function in ostree-repo-file
ostree_repo_file_get_checksum, function in ostree-repo-file
ostree_repo_file_get_repo, function in ostree-repo-file
ostree_repo_file_get_root, function in ostree-repo-file
ostree_repo_file_get_xattrs, function in ostree-repo-file
ostree_repo_file_tree_find_child, function in ostree-repo-file
ostree_repo_file_tree_get_contents, function in ostree-repo-file
ostree_repo_file_tree_get_contents_checksum, function in ostree-repo-file
ostree_repo_file_tree_get_metadata, function in ostree-repo-file
ostree_repo_file_tree_get_metadata_checksum, function in ostree-repo-file
ostree_repo_file_tree_query_child, function in ostree-repo-file
ostree_repo_file_tree_set_metadata, function in ostree-repo-file
ostree_repo_get_config, function in OstreeRepo
ostree_repo_get_dfd, function in OstreeRepo
ostree_repo_get_disable_fsync, function in OstreeRepo
ostree_repo_get_mode, function in OstreeRepo
ostree_repo_get_parent, function in OstreeRepo
ostree_repo_get_path, function in OstreeRepo
ostree_repo_get_remote_boolean_option, function in OstreeRepo
ostree_repo_get_remote_list_option, function in OstreeRepo
ostree_repo_get_remote_option, function in OstreeRepo
ostree_repo_gpg_verify_data, function in OstreeRepo
ostree_repo_hash, function in OstreeRepo
ostree_repo_has_object, function in OstreeRepo
ostree_repo_import_archive_to_mtree, function in OstreeRepo
ostree_repo_import_object_from, function in OstreeRepo
ostree_repo_import_object_from_with_trust, function in OstreeRepo
ostree_repo_is_system, function in OstreeRepo
ostree_repo_is_writable, function in OstreeRepo
ostree_repo_list_commit_objects_starting_with, function in OstreeRepo
ostree_repo_list_objects, function in OstreeRepo
OSTREE_REPO_LIST_OBJECTS_VARIANT_TYPE, macro in OstreeRepo
ostree_repo_list_refs, function in OstreeRepo
ostree_repo_list_refs_ext, function in OstreeRepo
ostree_repo_list_static_delta_names, function in OstreeRepo
ostree_repo_load_commit, function in OstreeRepo
ostree_repo_load_file, function in OstreeRepo
ostree_repo_load_object_stream, function in OstreeRepo
ostree_repo_load_variant, function in OstreeRepo
ostree_repo_load_variant_if_exists, function in OstreeRepo
ostree_repo_mode_from_string, function in OstreeRepo
ostree_repo_new, function in OstreeRepo
ostree_repo_new_default, function in OstreeRepo
ostree_repo_new_for_sysroot_path, function in OstreeRepo
ostree_repo_open, function in OstreeRepo
ostree_repo_open_at, function in OstreeRepo
ostree_repo_prepare_transaction, function in OstreeRepo
ostree_repo_prune, function in OstreeRepo
ostree_repo_prune_from_reachable, function in OstreeRepo
ostree_repo_prune_static_deltas, function in OstreeRepo
ostree_repo_pull, function in OstreeRepo
ostree_repo_pull_default_console_progress_changed, function in OstreeRepo
ostree_repo_pull_one_dir, function in OstreeRepo
ostree_repo_pull_with_options, function in OstreeRepo
ostree_repo_query_object_storage_size, function in OstreeRepo
ostree_repo_read_commit, function in OstreeRepo
ostree_repo_read_commit_detached_metadata, function in OstreeRepo
ostree_repo_regenerate_summary, function in OstreeRepo
ostree_repo_reload_config, function in OstreeRepo
ostree_repo_remote_add, function in OstreeRepo
ostree_repo_remote_change, function in OstreeRepo
ostree_repo_remote_delete, function in OstreeRepo
ostree_repo_remote_fetch_summary, function in OstreeRepo
ostree_repo_remote_fetch_summary_with_options, function in OstreeRepo
ostree_repo_remote_get_gpg_verify, function in OstreeRepo
ostree_repo_remote_get_gpg_verify_summary, function in OstreeRepo
ostree_repo_remote_get_url, function in OstreeRepo
ostree_repo_remote_gpg_import, function in OstreeRepo
ostree_repo_remote_list, function in OstreeRepo
ostree_repo_remote_list_refs, function in OstreeRepo
ostree_repo_resolve_rev, function in OstreeRepo
ostree_repo_resolve_rev_ext, function in OstreeRepo
ostree_repo_scan_hardlinks, function in OstreeRepo
ostree_repo_set_alias_ref_immediate, function in OstreeRepo
ostree_repo_set_cache_dir, function in OstreeRepo
ostree_repo_set_disable_fsync, function in OstreeRepo
ostree_repo_set_ref_immediate, function in OstreeRepo
ostree_repo_sign_commit, function in OstreeRepo
ostree_repo_sign_delta, function in OstreeRepo
ostree_repo_static_delta_execute_offline, function in OstreeRepo
ostree_repo_static_delta_generate, function in OstreeRepo
ostree_repo_transaction_set_ref, function in OstreeRepo
ostree_repo_transaction_set_refspec, function in OstreeRepo
ostree_repo_traverse_commit, function in OstreeRepo
ostree_repo_traverse_commit_union, function in OstreeRepo
ostree_repo_traverse_new_reachable, function in OstreeRepo
ostree_repo_verify_commit, function in OstreeRepo
ostree_repo_verify_commit_ext, function in OstreeRepo
ostree_repo_verify_commit_for_remote, function in OstreeRepo
ostree_repo_verify_summary, function in OstreeRepo
ostree_repo_write_archive_to_mtree, function in OstreeRepo
ostree_repo_write_commit, function in OstreeRepo
ostree_repo_write_commit_detached_metadata, function in OstreeRepo
ostree_repo_write_commit_with_time, function in OstreeRepo
ostree_repo_write_config, function in OstreeRepo
ostree_repo_write_content, function in OstreeRepo
ostree_repo_write_content_async, function in OstreeRepo
ostree_repo_write_content_finish, function in OstreeRepo
ostree_repo_write_content_trusted, function in OstreeRepo
ostree_repo_write_dfd_to_mtree, function in OstreeRepo
ostree_repo_write_directory_to_mtree, function in OstreeRepo
ostree_repo_write_metadata, function in OstreeRepo
ostree_repo_write_metadata_async, function in OstreeRepo
ostree_repo_write_metadata_finish, function in OstreeRepo
ostree_repo_write_metadata_stream_trusted, function in OstreeRepo
ostree_repo_write_metadata_trusted, function in OstreeRepo
ostree_repo_write_mtree, function in OstreeRepo

### S

OstreeSePolicy, typedef in SELinux policy management
OstreeSePolicyRestoreconFlags, enum in SELinux policy management
ostree_sepolicy_fscreatecon_cleanup, function in SELinux policy management
ostree_sepolicy_get_csum, function in SELinux policy management
ostree_sepolicy_get_label, function in SELinux policy management
ostree_sepolicy_get_name, function in SELinux policy management
ostree_sepolicy_get_path, function in SELinux policy management
ostree_sepolicy_new, function in SELinux policy management
ostree_sepolicy_new_at, function in SELinux policy management
ostree_sepolicy_restorecon, function in SELinux policy management
ostree_sepolicy_setfscreatecon, function in SELinux policy management
OstreeStaticDeltaGenerateOpt, enum in OstreeRepo
OSTREE_SUMMARY_GVARIANT_FORMAT, macro in Core repository-independent functions
OSTREE_SUMMARY_GVARIANT_STRING, macro in Core repository-independent functions
OstreeSysroot, typedef in Root partition mount point
OstreeSysrootSimpleWriteDeploymentFlags, enum in Root partition mount point
OstreeSysrootUpgrader, typedef in Simple upgrade class
OstreeSysrootUpgraderFlags, enum in Simple upgrade class
OstreeSysrootUpgraderPullFlags, enum in Simple upgrade class
ostree_sysroot_cleanup, function in Root partition mount point
ostree_sysroot_deployment_set_kargs, function in Root partition mount point
ostree_sysroot_deployment_set_mutable, function in Root partition mount point
ostree_sysroot_deployment_unlock, function in Root partition mount point
ostree_sysroot_deploy_tree, function in Root partition mount point
ostree_sysroot_ensure_initialized, function in Root partition mount point
ostree_sysroot_get_booted_deployment, function in Root partition mount point
ostree_sysroot_get_bootversion, function in Root partition mount point
ostree_sysroot_get_deployments, function in Root partition mount point
ostree_sysroot_get_deployment_directory, function in Root partition mount point
ostree_sysroot_get_deployment_dirpath, function in Root partition mount point
ostree_sysroot_get_deployment_origin_path, function in Root partition mount point
ostree_sysroot_get_fd, function in Root partition mount point
ostree_sysroot_get_merge_deployment, function in Root partition mount point
ostree_sysroot_get_path, function in Root partition mount point
ostree_sysroot_get_repo, function in Root partition mount point
ostree_sysroot_get_subbootversion, function in Root partition mount point
ostree_sysroot_init_osname, function in Root partition mount point
ostree_sysroot_load, function in Root partition mount point
ostree_sysroot_load_if_changed, function in Root partition mount point
ostree_sysroot_lock, function in Root partition mount point
ostree_sysroot_lock_async, function in Root partition mount point
ostree_sysroot_lock_finish, function in Root partition mount point
ostree_sysroot_new, function in Root partition mount point
ostree_sysroot_new_default, function in Root partition mount point
ostree_sysroot_origin_new_from_refspec, function in Root partition mount point
ostree_sysroot_prepare_cleanup, function in Root partition mount point
ostree_sysroot_query_deployments_for, function in Root partition mount point
ostree_sysroot_repo, function in Root partition mount point
ostree_sysroot_simple_write_deployment, function in Root partition mount point
ostree_sysroot_try_lock, function in Root partition mount point
ostree_sysroot_unload, function in Root partition mount point
ostree_sysroot_unlock, function in Root partition mount point
ostree_sysroot_upgrader_check_timestamps, function in Simple upgrade class
ostree_sysroot_upgrader_deploy, function in Simple upgrade class
ostree_sysroot_upgrader_dup_origin, function in Simple upgrade class
ostree_sysroot_upgrader_get_origin, function in Simple upgrade class
ostree_sysroot_upgrader_get_origin_description, function in Simple upgrade class
ostree_sysroot_upgrader_new, function in Simple upgrade class
ostree_sysroot_upgrader_new_for_os, function in Simple upgrade class
ostree_sysroot_upgrader_new_for_os_with_flags, function in Simple upgrade class
ostree_sysroot_upgrader_pull, function in Simple upgrade class
ostree_sysroot_upgrader_pull_one_dir, function in Simple upgrade class
ostree_sysroot_upgrader_set_origin, function in Simple upgrade class
ostree_sysroot_write_deployments, function in Root partition mount point
ostree_sysroot_write_deployments_with_options, function in Root partition mount point
ostree_sysroot_write_origin_file, function in Root partition mount point

### T

OSTREE_TREE_GVARIANT_FORMAT, macro in Core repository-independent functions
OSTREE_TREE_GVARIANT_STRING, macro in Core repository-independent functions

### V

ostree_validate_checksum_string, function in Core repository-independent functions
ostree_validate_remote_name, function in Core repository-independent functions
ostree_validate_rev, function in Core repository-independent functions
ostree_validate_structureof_checksum_string, function in Core repository-independent functions
ostree_validate_structureof_commit, function in Core repository-independent functions
ostree_validate_structureof_csum_v, function in Core repository-independent functions
ostree_validate_structureof_dirmeta, function in Core repository-independent functions
ostree_validate_structureof_dirtree, function in Core repository-independent functions
ostree_validate_structureof_file_mode, function in Core repository-independent functions
ostree_validate_structureof_objtype, function in Core repository-independent functions
OSTREE_VERSION, macro in ostree-version
OSTREE_VERSION_HEX, macro in ostree-version
OSTREE_VERSION_S, macro in ostree-version

### Y

OSTREE_YEAR_VERSION, macro in ostree-version