Reference

This section details the core API reference along with other more elaborate details about BuildStream internals.

• Project format
  • Introduction
  • Project configuration
  • Declaring elements
  • Builtin public data
  • The project.refs file
• Plugin specific documentation
  • General elements
  • Build elements
  • Sources
  • External plugins
• Plugin API reference
  • 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()
• Additional writings
  • Cache keys
  • Sandboxing