Struct build_details::BuildDetails

pub struct BuildDetails { /* fields omitted */ }

Code generator for build details. See the crate documentation for an example.

Methods

impl BuildDetails

pub fn all() -> Self

Construct a BuildDetails instance with all available details marked as optional.

pub fn none() -> Self

Construct a BuildDetails instance with no included details.

This method isn't particularly useful by itself, and will probably need customization with BuildDetails::include and BuildDetails::exclude.

pub fn require(&mut self, detail: BuildDetail) -> &mut Self

Include a BuildDetail, and mark it as required.

If a detail is marked as required and isn't available at build time, the build will fail.

pub fn include(&mut self, detail: BuildDetail) -> &mut Self

Include a BuildDetail, and mark it as optional.

If a detail is marked as optional and isn't available at build time, the generated value will be None.

pub fn exclude(&mut self, detail: BuildDetail) -> &mut Self

Exclude a BuildDetail. It will not show up in the generated output.

pub fn generate<P: AsRef<Path>>(&self, path: P) -> Result<()>

Creates a file called path in the build's OUT_DIR directory. See the crate documentation for an example.

pub fn write_to(&self, out_file: &mut Write) -> Result<()>

Writes the generated code to a [`::std::io::Write'] instead of to a file.

Trait Implementations

impl Debug for BuildDetails

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

Formats the value using the given formatter.

impl Clone for BuildDetails

fn clone(&self) -> BuildDetails

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for BuildDetails

fn default() -> Self

Returns the "default value" for a type.