#[non_exhaustive]pub struct DescriptionYml {Show 16 fields
pub name: String,
pub description: String,
pub version: Option<String>,
pub language: String,
pub build: String,
pub license: String,
pub requires_toolchains: String,
pub excluded_platforms: String,
pub opt_in_platforms: String,
pub maintainers: Vec<String>,
pub github: String,
pub git_ref: String,
pub git_ref_next: String,
pub git_ref_variegata: String,
pub git_ref_andium: String,
pub warnings: Vec<String>,
}Expand description
A validated representation of a DuckDB community extension description.yml.
Construct via parse_description_yml or validate_description_yml_str.
Every field was validated during construction. Things the community build
accepts but that are probably not what the author meant — a licence outside
quack-rs’s SPDX shortlist, a list-form excluded_platforms, the British
spelling licence: — do not fail the parse; they are reported in
warnings.
#[non_exhaustive]: new fields can be added without a breaking release, so
read fields by name rather than destructuring.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.name: StringExtension name (validated: a lowercase letter, then lowercase letters, digits and underscores).
description: StringOne-line description of the extension.
version: Option<String>Extension version, when the file declares one (validated: see
validate_extension_version).
Optional: the community build never reads it (scripts/build.py in
duckdb/community-extensions takes the version from the extension’s
own repository), and 12 of the 346 published files omit it.
language: StringImplementation language (for Rust extensions: "Rust").
build: StringBuild system (for Rust extensions: "cargo").
license: StringThe declared license — an SPDX identifier or expression when the file
follows the convention. Only presence is enforced; see
warnings.
requires_toolchains: StringSemicolon-separated required toolchains (must include "rust" for Rust extensions).
excluded_platforms: StringPlatforms to exclude from CI builds, semicolon-separated. Empty means no
exclusions. A YAML list in the file is joined with ; here (and warned
about: the community build passes a list through unsplit).
opt_in_platforms: StringOpt-in platforms to build, semicolon-separated (extension.opt_in_platforms).
Empty when absent.
The community build only builds the platforms in
DUCKDB_OPT_IN_PLATFORMS when
they are listed here. A name that is not one of them, or that is not a
platform at all, is ignored by the build and reported in
warnings.
maintainers: Vec<String>List of maintainer names (at least one required).
github: StringGitHub repository in owner/repo format.
git_ref: StringThe git ref the community build checks out: a commit hash. A branch or
tag is accepted with a warning in DescriptionYml::warnings.
git_ref_next: Stringrepo.ref_next — a revision compatible with DuckDB’s main branch,
empty when absent.
Optional, and documented by DuckDB for the window while a new release
is being prepared: the community repository tests an extension against
both the latest stable release and main, and once the release hash is
set ref_next is swapped in for ref.
git_ref_variegata: Stringrepo.variegata — the revision the community build checks out when it
builds for DuckDB v1.5.6 (the v1.5-variegata release line) instead
of git_ref; empty when absent. 133 of the 395
published descriptors set it.
ref is built for the newest release (v2.0.0). An extension stamped
for one exact DuckDB 1.x release (C_STRUCT_UNSTABLE) needs its
v1.5.6 build here, from a revision whose Makefile targets v1.5.6.
git_ref_andium: Stringrepo.andium — as git_ref_variegata, for
DuckDB v1.4.5 (the v1.4-andium line); empty when absent.
warnings: Vec<String>Non-fatal findings, one human-readable sentence each: the file is accepted, but something in it is unusual enough to be worth a look.
Trait Implementations§
Source§impl Clone for DescriptionYml
impl Clone for DescriptionYml
Source§fn clone(&self) -> DescriptionYml
fn clone(&self) -> DescriptionYml
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read more