Struct SbomConfig 

pub struct SbomConfig {
    pub id: Option<String>,
    pub cmd: Option<String>,
    pub env: Option<Vec<String>>,
    pub args: Option<Vec<String>>,
    pub documents: Option<Vec<String>>,
    pub artifacts: Option<String>,
    pub ids: Option<Vec<String>>,
    pub skip: Option<StringOrBool>,
}

Fields

id: Option<String>

Unique identifier for this SBOM config (default: “default”).

cmd: Option<String>

Command to run for SBOM generation (default: “syft”).

env: Option<Vec<String>>

Environment variables to pass to the command, as KEY=VALUE strings. Order is preserved. Values are template-rendered before being set.

args: Option<Vec<String>>

Command-line arguments (supports templates and $artifact, $document vars).

documents: Option<Vec<String>>

Output document path templates (supports templates).

artifacts: Option<String>

Which artifacts to catalog: “source”, “archive”, “binary”, “package”, “diskimage”, “installer”, “any” (default: “archive”).

ids: Option<Vec<String>>

Filter by artifact IDs (ignored if artifacts=“source”).

skip: Option<StringOrBool>

Skip this SBOM config. Accepts bool or template string.

Implementations

impl SbomConfig

pub const DEFAULT_ID: &'static str = "default"

Default id when an SBOM config has none. Mirrors GoReleaser internal/pipe/sbom/sbom.go (cfg.ID = "default").

pub const DEFAULT_CMD: &'static str = "syft"

Default SBOM-generation command. Mirrors GoReleaser sbom.go (cfg.Cmd = "syft").

pub const DEFAULT_ARTIFACTS: &'static str = "archive"

Default artifacts filter. Mirrors GoReleaser sbom.go (cfg.Artifacts = "archive").

pub const DEFAULT_DOCUMENT_BINARY: &'static str = "{{ .Binary }}_{{ .Version }}_{{ .Os }}_{{ .Arch }}.sbom.json"

Default document-path template when artifacts: binary. Includes per-target Os/Arch suffix so per-arch SBOMs don’t collide. Mirrors GoReleaser sbom.go.

pub const DEFAULT_DOCUMENT_OTHER: &'static str = "{{ .ArtifactName }}.sbom.json"

Default document-path template for any non-binary, non-any artifacts: filter. Mirrors GoReleaser sbom.go.

pub const DEFAULT_SYFT_ARGS: &[&'static str]

Default args for the syft command. Mirrors GoReleaser sbom.go. Anodize matches GR’s shell-style $artifact / $document placeholders verbatim — the arg-renderer rewrites these to per-artifact values at execution time.

pub const DEFAULT_SYFT_ENV_KEY: &'static str = "SYFT_FILE_METADATA_CATALOGER_ENABLED"

Env entry that syft requires to emit file paths in the SBOM when cataloging archives or source. Mirrors GoReleaser sbom.go.

pub const DEFAULT_SYFT_ENV_VAL: &'static str = "true"

pub fn resolved_id(&self) -> &str

Resolve the SBOM-config id, falling back to "default".

pub fn resolved_cmd(&self) -> &str

Resolve the SBOM command, falling back to "syft".

pub fn resolved_artifacts(&self) -> &str

Resolve the artifacts: filter, falling back to "archive".

pub fn resolved_documents(&self, artifacts: &str) -> Vec<String>

Resolve documents, falling back to the artifact-type-specific default when unset. Caller should pass the result of Self::resolved_artifacts for artifacts.

pub fn resolved_args(&self, cmd: &str) -> Vec<String>

Resolve args, falling back to Self::DEFAULT_SYFT_ARGS when cmd is "syft"; empty vec otherwise (matches GoReleaser: sbom.go only initializes args when cmd is syft, and leaves args empty for other cmds).

pub fn default_syft_env_for(cmd: &str, artifacts: &str) -> Vec<(String, String)>

Default env additions for the syft sub-process. Empty unless cmd is syft AND artifacts is source/archive — in which case syft needs the file-metadata cataloger enabled to produce file paths in the SBOM. Mirrors GoReleaser sbom.go.

Trait Implementations

impl Clone for SbomConfig

fn clone(&self) -> SbomConfig

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SbomConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for SbomConfig

fn default() -> SbomConfig

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SbomConfig

where SbomConfig: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for SbomConfig

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl Serialize for SbomConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.