Plugin API reference

The core public APIs are of interest to anyone who wishes to implement custom Element or Source plugins, and can also be useful for working on BuildStream itself.

• Plugin - Base plugin class
• Plugin
• Source - Base source class
• SourceFetcher - Object for fetching individual URLs
• Consistency
• SourceError
• SourceFetcher
• Source
• Element - Base element class
• Scope
• ElementError
• Element
• BuildElement - Abstract class for build elements
• BuildElement
• ScriptElement - Abstract class for scripting elements
• ScriptElement
• setup()
• Sandbox - The build sandbox
• SandboxFlags
• Sandbox
• Utilities
• UtilError
• ProgramNotFoundError
• FileListResult
• list_relative_paths()
• glob()
• sha256sum()
• safe_copy()
• safe_link()
• safe_remove()
• copy_files()
• link_files()
• get_host_tool()
• url_directory_name()
• get_bst_version()
• save_file_atomic()