Struct hakari::summaries::HakariBuilderSummary

#[non_exhaustive]
pub struct HakariBuilderSummary {
    pub hakari_package: Option<String>,
    pub resolver: CargoResolverVersion,
    pub unify_target_host: UnifyTargetHost,
    pub output_single_feature: bool,
    pub dep_format_version: DepFormatVersion,
    pub workspace_hack_line_style: WorkspaceHackLineStyle,
    pub platforms: Vec<String>,
    pub traversal_excludes: PackageSetSummary,
    pub final_excludes: PackageSetSummary,
    pub registries: BTreeMap<String, String>,
}

A HakariBuilder in serializable form. This forms the configuration file format for hakari.

For an example, see the cargo-hakari README.

Requires the cli-support feature to be enabled.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

hakari_package: Option<String>

The name of the Hakari package in the workspace.

resolver: CargoResolverVersion

The Cargo resolver version used.

For more information, see the documentation for CargoResolverVersion.

unify_target_host: UnifyTargetHost

Unification across target and host.

output_single_feature: bool

Whether all dependencies were unified.

dep_format_version: DepFormatVersion

Format version for hakari.

workspace_hack_line_style: WorkspaceHackLineStyle

Format kind for workspace-hack = { ... } lines.

platforms: Vec<String>

The platforms used by the HakariBuilder.

traversal_excludes: PackageSetSummary

The list of packages excluded during graph traversals.

final_excludes: PackageSetSummary

The list of packages excluded from the final output.

registries: BTreeMap<String, String>

The list of alternate registries, as a map of name to URL.

This is a temporary workaround until Cargo issue #9052 is resolved.

Implementations

impl HakariBuilderSummary

pub fn new(builder: &HakariBuilder<'_>) -> Result<Self, TargetSpecError>

Creates a new HakariBuilderSummary from a builder.

Requires the cli-support feature to be enabled.

Returns an error if there are any custom platforms. Serializing custom platforms is currently unsupported.

pub fn to_hakari_builder<'g>( &self, graph: &'g PackageGraph ) -> Result<HakariBuilder<'g>, Error>

Creates a HakariBuilder from this summary and a PackageGraph.

Returns an error if this summary references a package that’s not present, or if there was some other issue while creating a HakariBuilder from this summary.

pub fn to_string(&self) -> Result<String, Error>

Serializes this summary to a TOML string.

Returns an error if writing out the TOML was unsuccessful.

pub fn write_comment(&self, out: impl Write) -> Result<(), TomlOutError>

Serializes this summary to a TOML string, and adds # comment markers to the beginning of each line.

Returns an error if writing out the TOML was unsuccessful.

pub fn write_to_string(&self, dst: &mut String) -> Result<(), Error>

Writes out the contents of this summary as TOML to the given string.

Returns an error if writing out the TOML was unsuccessful.

Trait Implementations

impl Clone for HakariBuilderSummary

fn clone(&self) -> HakariBuilderSummary

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for HakariBuilderSummary

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for HakariBuilderSummary

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for HakariBuilderSummary

fn eq(&self, other: &HakariBuilderSummary) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for HakariBuilderSummary

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for HakariBuilderSummary

impl StructuralPartialEq for HakariBuilderSummary