Struct buildtime_png::Builder

pub struct Builder { /* fields omitted */ }

Methods

impl Builder

pub fn new() -> Self

Simply calls Builder::default().

pub fn with_out_dir<P: AsRef<Path>>(&mut self, outdir: P) -> &mut Self

Customize where the pixel .data files are placed in.

Because absolute paths is used in the generated rust code, you do not have to worry about where these files are, usually.

Default is OUT_DIR

pub fn include_png<P: AsRef<Path>>(
    &mut self,
    path_rel_to_root: P,
    ident: &str
) -> &mut Self

Add a image.

This method will read the image pointed to by path_rel_to_root, decode it, and emits relevant .data files into the out_dir perviously set (default to OUT_DIR).

Arguments

• path_rel_to_root - Path of the image, relative to the directory where your Cargo.toml is placed.

ident - An identifier for the image to use in your code. Must be valid rust identifiers, such as image, left_arrow and not 123, a/b, a b, a-b or a::b.

pub fn emit_source_file(&self) -> Result<()>

Emit the rust source file to $OUTDIR/image.rs

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

Emit the rust source file to the provided path, relative to the output directory.

Source file contains absolute paths, so you don't have to worry about the placement of it.

Trait Implementations

impl Default for Builder

fn default() -> Self

Returns the "default value" for a type.