Struct docima::ImageFile

pub struct ImageFile { /* fields omitted */ }

An image file generator.

The minimum required setup methods are: width, height and path

Example

ImageFile::new()
    .width(600)
    .height(400)
    .path("images/plotters-histogram.html")
    .overwrite(true)
    .title("the title")
    .alt("the alt text")
    .wrapper("div")
    .wrapper_style("padding: 10px; background-color: red;")
    .generate(my_generator_function)?;

Implementations

impl ImageFile

Constructor & Generator

pub fn new() -> Self

Start configuring a new image.

pub fn generate(
    self,
    generator: impl Fn(&mut Vec<u8>, u32, u32) -> StdResult<()>
) -> DocimaResult<()>

Finishes the image, calling the generator function and saving the file.

impl ImageFile

Required Configuration methods

pub fn width(self, width: u32) -> Self

Sets the width of the image.

pub fn height(self, height: u32) -> Self

Sets the height of the image.

pub fn path(self, path: &str) -> Self

Sets the name and path of the output file, including the path from the project’s root.

impl ImageFile

Optional Configuration methods

pub fn attr(self, attribute: &str, value: &str) -> Self

Sets the chosen attribute for the <img> tag.

Valid attributes are: “alt”, “title”, “id”, “class”, “style”, …

pub fn wrapper(self, wrapper: &str) -> Self

Sets the wrapper HTML tag around <img>.

pub fn wrapper_attr(self, attribute: &str, value: &str) -> Self

Sets an attribute for the wrapper tag around <img>.

Valid attributes are: “alt”, “title”, “id”, “class”, “style”… And if the wrapper is an anchor “a”, then “href” & “target”.

pub fn overwrite(self, overwrite: bool) -> Self

Sets the overwrite preference for the generated image.

If false the image will only be generated if the chosen output file doesn’t already exist. If true the image will always be generated, and the file overwritten.

Trait Implementations

impl Default for ImageFile

fn default() -> Self

Returns the “default value” for a type.