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.
- Foundation types
FastEnumCoreWarningsOverlapActionSourceRef- Node - Parsed YAML configuration
MappingNodeNodeProvenanceInformationScalarNodeSequenceNode- Plugin - Base plugin class
Plugin- Source - Base source class
- SourceFetcher - Object for fetching individual URLs
SourceErrorSourceImplErrorAliasSubstitutionSourceInfoMediumSourceVersionTypeSourceInfoSourceFetcherSource- SourceMirror - Base source mirror class
SourceMirrorErrorSourceMirror- DownloadableFileSource - Abstract class for sources downloaded from a URI
DownloadableFileSource- Element - Base element class
ElementErrorDependencyConfigurationElement- BuildElement - Abstract class for build elements
BuildElement- ScriptElement - Abstract class for scripting elements
ScriptElementsetup()- Sandbox - The build sandbox
SandboxCommandErrorSandbox- Directory - Interfacing with files
DirectoryErrorFileTypeFileStatDirectory- Exceptions - API for Error Handling
ErrorDomainLoadErrorReason- Utilities
UtilErrorProgramNotFoundErrorDirectoryExistsErrorFileListResultlist_relative_paths()glob()sha256sum()safe_copy()safe_link()safe_remove()copy_files()link_files()get_host_tool()get_bst_version()move_atomic()save_file_atomic()get_umask()