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 alt(self, alt: &str) -> Self

Sets the <img> alt attribute.

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

Sets the <img> title attribute.

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

Sets the <img> id attribute.

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

Sets the <img> class attribute.

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

Sets the <img> style attribute.

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

Sets the wrapper HTML tag around <img>.

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

Sets the wrapper tag alt attribute.

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

Sets the wrapper tag title attribute.

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

Sets the wrapper tag id attribute.

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

Sets the wrapper tag class attribute.

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

Sets the wrapper tag style attribute.

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

Sets the wrapper tag href attribute.

The wrapper must be an anchor tag (a) in order for this to be used.

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

Sets the wrapper tag target attribute.

The wrapper must be an anchor tag (a) in order for this to be used.

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

Sets the wrapper tag style attribute.

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.