Enum BuildpackDescriptor 

pub enum BuildpackDescriptor<BM = GenericMetadata> {
    Component(ComponentBuildpackDescriptor<BM>),
    Composite(CompositeBuildpackDescriptor<BM>),
}

Data structures for the Buildpack descriptor (buildpack.toml).

For parsing of buildpack.toml files when support for multiple types of buildpack is required.

When a specific buildpack type is expected, use ComponentBuildpackDescriptor or CompositeBuildpackDescriptor directly instead, since they allow for more detailed error messages if parsing fails.

Example:

use libcnb_data::buildpack::BuildpackDescriptor;

let toml_str = r#"
api = "0.10"

[buildpack]
id = "foo/bar"
name = "Bar Buildpack"
version = "0.0.1"
homepage = "https://www.foo.com/bar"
clear-env = false
description = "A buildpack for Foo Bar"
keywords = ["foo"]

[[buildpack.licenses]]
type = "BSD-3-Clause"
"#;

let buildpack_descriptor =
    toml::from_str::<BuildpackDescriptor>(toml_str)
        .expect("buildpack.toml did not match a known type!");
match buildpack_descriptor {
    BuildpackDescriptor::Component(buildpack) => {
        println!("Found component buildpack: {}", buildpack.buildpack.id);
    }
    BuildpackDescriptor::Composite(buildpack) => {
        println!("Found composite buildpack: {}", buildpack.buildpack.id);
    }
};

Variants

Component(ComponentBuildpackDescriptor<BM>)

Composite(CompositeBuildpackDescriptor<BM>)

Implementations

impl<BM> BuildpackDescriptor<BM>

pub fn buildpack(&self) -> &Buildpack

Trait Implementations

impl<BM: Debug> Debug for BuildpackDescriptor<BM>

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

Formats the value using the given formatter.

impl<'de, BM> Deserialize<'de> for BuildpackDescriptor<BM>

where BM: Deserialize<'de>,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.