panimg-core 0.3.0

Core library for panimg image processing
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58

use crate::error::Result;
use crate::ops::{Operation, OperationDescription};
use image::DynamicImage;
use serde::Serialize;

/// A pipeline of image operations to be applied in order.
pub struct Pipeline {
    operations: Vec<Box<dyn Operation>>,
}

/// Dry-run plan output.
#[derive(Debug, Serialize)]
pub struct PipelinePlan {
    pub steps: Vec<OperationDescription>,
}

impl Pipeline {
    pub fn new() -> Self {
        Self {
            operations: Vec::new(),
        }
    }

    pub fn push<O: Operation + 'static>(mut self, op: O) -> Self {
        self.operations.push(Box::new(op));
        self
    }

    pub fn push_boxed(mut self, op: Box<dyn Operation>) -> Self {
        self.operations.push(op);
        self
    }

    /// Execute all operations in order on the given image.
    pub fn execute(&self, mut img: DynamicImage) -> Result<DynamicImage> {
        for op in &self.operations {
            img = op.apply(img)?;
        }
        Ok(img)
    }

    /// Return a plan of what would be executed (for --dry-run).
    pub fn describe(&self) -> PipelinePlan {
        PipelinePlan {
            steps: self.operations.iter().map(|op| op.describe()).collect(),
        }
    }

    pub fn is_empty(&self) -> bool {
        self.operations.is_empty()
    }
}

impl Default for Pipeline {
    fn default() -> Self {
        Self::new()
    }
}