Struct bmp_monochrome::Bmp

pub struct Bmp { /* private fields */ }

The Bmp struct contains the data as a vector of vectors of booleans. Each boolean represent a pixel. In rows the first element is the upper row, inside the first vector there are the pixel from left to right, thus rows[0][0] is the upper-left element. Max len of the vetors (both rows and colums) is u16::MAX` Note in the serialized format the first element is the lower-left pixel see BMP file format

Implementations

impl Bmp

pub fn read<T: Read>(from: T) -> Result<Self, BmpError>

Read the monochrome bitmap from a Read type, such a File note that File read are not buffered and may be slow, see Read Trait

impl Bmp

pub fn write<T: Write>(&self, to: T) -> Result<(), BmpError>

Write the monochrome bitmap to a Write type, such a File

impl Bmp

pub fn new(rows: Vec<Vec<bool>>) -> Result<Bmp, BmpError>

Creates a new Bmp, failing if rows is empty or it’s first element is empty or it’s elements has different len

pub fn height(&self) -> u16

return the Bmp height in pixel

pub fn width(&self) -> u16

return the Bmp width in pixel

pub fn get(&self, i: u16, j: u16) -> bool

return the pixel situated at (i,j), where (0,0) is the upper-left corner could panic if i > self.height() || j > self.width()

pub fn mul(&self, mul: u8) -> Result<Bmp, BmpError>

return a new Bmp where every pixel is multiplied by mul, erroring if mul is 0 or 1 or the resulting image would be bigger than limits enforced by [crate::check_size]

pub fn div(&self, div: u8) -> Result<Bmp, BmpError>

return a new Bmp where every square is divided by div if all the square is not of the same color it errors

pub fn normalize(&self) -> Bmp

normalize removes the white border if any, and reduce the module pixel size to 1 (the module must be smaller than 10x10 pixel)

pub fn add_white_border(&self, border_size: u8) -> Result<Bmp, BmpError>

return a new Bmp with border_size pixels around

pub fn remove_white_border(&self) -> Bmp

remove all the white border, if any

pub fn display(&self) -> StringOutput<'_>

Return a struct implementing Display to visualize in terminal or in tests

pub fn inverse(&self) -> Bmp

Return inverted bitmap, black pixels become white and viceversa.

Trait Implementations

impl Clone for Bmp

fn clone(&self) -> Bmp

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Bmp

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

Formats the value using the given formatter.

impl PartialEq<Bmp> for Bmp

fn eq(&self, other: &Bmp) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Bmp

impl StructuralEq for Bmp

impl StructuralPartialEq for Bmp