ostree/rust-bindings/rust/conf/ostree.toml

[options]
work_mode = "normal"
library = "OSTree"
version = "1.0"
target_path = ".."
doc_target_path = "../target/vendor.md"
deprecate_by_min_version = true
single_version_file = true
generate_display_trait = true

girs_dir = "../gir-files"

generate = [
    "OSTree.AsyncProgress",
    "OSTree.BootconfigParser",
    "OSTree.ChecksumFlags",
    "OSTree.Deployment",
    "OSTree.DeploymentUnlockedState",
    "OSTree.DiffFlags",
    "OSTree.DiffItem",
    "OSTree.GpgSignatureAttr",
    "OSTree.GpgSignatureFormatFlags",
    "OSTree.GpgVerifyResult",
    "OSTree.MutableTree",
    "OSTree.ObjectType",
    "OSTree.Remote",
    "OSTree.RepoCheckoutFilterResult",
    "OSTree.RepoCheckoutMode",
    "OSTree.RepoCheckoutOverwriteMode",
    "OSTree.RepoCommitFilterResult",
    "OSTree.RepoCommitFilter",
    "OSTree.RepoCommitIterResult",
    "OSTree.RepoCommitModifierFlags",
    "OSTree.RepoCommitTraverseFlags",
    "OSTree.RepoCommitModifier",
    "OSTree.RepoCommitState",
    "OSTree.RepoDevInoCache",
    "OSTree.RepoFile",
    "OSTree.RepoFinder",
    "OSTree.RepoFinderAvahi",
    "OSTree.RepoFinderConfig",
    "OSTree.RepoFinderMount",
    "OSTree.RepoFinderOverride",
    "OSTree.RepoListObjectsFlags",
    "OSTree.RepoListRefsExtFlags",
    "OSTree.RepoMode",
    "OSTree.RepoPruneFlags",
    "OSTree.RepoPullFlags",
    "OSTree.RepoRemoteChange",
    "OSTree.RepoResolveRevExtFlags",
    "OSTree.SePolicy",
    "OSTree.SePolicyRestoreconFlags",
    "OSTree.StaticDeltaGenerateOpt",
    "OSTree.Sysroot",
    "OSTree.SysrootSimpleWriteDeploymentFlags",
    "OSTree.SysrootUpgrader",
    "OSTree.SysrootUpgraderFlags",
    "OSTree.SysrootUpgraderPullFlags",

]

manual = [
    # types from glib/gio we need
    "Gio.AsyncReadyCallback",
    "Gio.AsyncResult",
    "Gio.Cancellable",
    "Gio.File",
    "Gio.FileInfo",
    "Gio.FileQueryInfoFlags",
    "Gio.FilterInputStream",
    "Gio.InputStream",
    "Gio.VolumeMonitor",
    "GLib.Bytes",
    "GLib.Checksum",
    "GLib.DestroyNotify",
    "GLib.Error",
    "GLib.KeyFile",
    "GLib.MainContext",
    "GLib.Quark",
    "GLib.String",
    "GLib.Variant",
    "GLib.VariantType",

    # types implemented by hand
    "OSTree.RepoCheckoutAtOptions",
    "OSTree.RepoCheckoutFilter",
]

ignore = [
    # only used for the already-deprecated checkout_tree_at function
    "OSTree.RepoCheckoutOptions",
    # types for zero-terminated arrays we probably don't want
    "OSTree.CollectionRefv",
    "OSTree.RepoFinderResultv",
    # not part of the public interface, as far as I can tell
    "OSTree.Bootloader",
    "OSTree.BootloaderGrub2",
    "OSTree.BootloaderInterface",
    "OSTree.BootloaderSyslinux",
    "OSTree.BootloaderUboot",
    "OSTree.ChecksumInputStream",
    "OSTree.ChecksumInputStreamBuilder",
    "OSTree.CmdPrivateVTable",
    "OSTree.GpgVerifier",
    "OSTree.LibarchiveInputStream",
    "OSTree.LzmaCompressor",
    "OSTree.LzmaDecompressor",
    "OSTree.RollsumMatches",
    # builders we don't want
    "OSTree.RepoBuilder",
    "OSTree.SysrootBuilder",
]

[crate_name_overrides]
os_tree = "ostree"

[[object]]
name = "OSTree.CollectionRef"
status = "generate"
    [[object.function]]
    # helper functions for NULL-terminated arrays
    pattern = "dupv|freev"
    ignore = true

    [[object.function]]
    # clone() should already be this
    name = "dup"
    ignore = true

[[object]]
name = "OSTree.Repo"
status = "generate"
    [[object.function]]
    # this one crashes gir, somehow
    name = "write_metadata_async"
    ignore = true
    [[object.function]]
    # this one generates a guchar** incorrectly
    name = "write_content_async"
    ignore = true
    [[object.function]]
    # these fail because of issues with zero-terminated arrays
    pattern = "find_remotes_async|pull_from_remotes_async"
    ignore = true

    [[object.function]]
    # this is deprecated and supposedly unsafe for GI
    name = "checkout_tree_at"
    ignore = true

    [[object.function]]
    # TODO: see which of these annotations I can upstream
    name = "checkout_at"
    [[object.function.parameter]]
    name = "options"
    const = true
    [[object.function.parameter]]
    name = "destination_path"
    string_type = "filename"

[[object]]
name = "OSTree.RepoFinderResult"
status = "generate"
    [[object.function]]
    # array helper function
    name = "freev"
    ignore = true

    [[object.function]]
    # clone() should already be this
    name = "dup"
    ignore = true

[[object]]
name = "OSTree.RepoTransactionStats"
status = "generate"
init_function_expression = "|_ptr| ()"
clear_function_expression = "|_ptr| ()"

[[object]]
name = "OSTree.*"
status = "generate"
    [[object.function]]
    # both too low-level to be generated safely
    pattern = "cmp_checksum_bytes|checksum_inplace_to_bytes"
    ignore = true

    [[object.constant]]
    # version-dependent constants
    pattern = "VERSION|VERSION_S|YEAR_VERSION|RELEASE_VERSION"
    ignore = true