Struct Encoder 

pub struct Encoder<W: Write> { /* private fields */ }

Encoder for XBM images.

Implementations

impl<W: Write> Encoder<W>

pub const fn new(writer: W) -> Self

Creates a new Encoder.

Examples

let buf = [].as_mut_slice();
let encoder = Encoder::new(buf);

pub fn encode( self, buf: impl AsRef<[u8]>, name: impl AsRef<str>, width: u32, height: u32, x_hot: Option<u32>, y_hot: Option<u32>, ) -> Result<(), Error>

Encodes the binary image buf.

0 represents a white pixel and 1 represents a black pixel.

name accepts a string which follow the specification in Unicode Standard Annex #31, but it is recommended that name be restricted to the ASCII subset of XID_Start and XID_Continue.

width should be a multiple of 8.

Errors

Returns Err if an error occurs during I/O operations.

Panics

Panics if the length of buf and the image dimensions (the width multiplied by the height) are different.

Examples

// "B" (8x7)
let pixels = b"\x00\x00\x00\x00\x00\x00\x00\x00\
               \x00\x00\x01\x01\x01\x00\x00\x00\
               \x00\x00\x01\x00\x00\x01\x00\x00\
               \x00\x00\x01\x01\x01\x00\x00\x00\
               \x00\x00\x01\x00\x00\x01\x00\x00\
               \x00\x00\x01\x01\x01\x00\x00\x00\
               \x00\x00\x00\x00\x00\x00\x00\x00";

let mut buf = [u8::default(); 131];
let encoder = Encoder::new(buf.as_mut_slice());
encoder.encode(pixels, "image", 8, 7, None, None).unwrap();
assert_eq!(buf, *include_bytes!("../tests/data/basic.xbm"));

Trait Implementations

impl<W: Debug + Write> Debug for Encoder<W>

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

Formats the value using the given formatter.

impl<W: Write> ImageEncoder for Encoder<W>

Available on crate feature image only.

fn write_image( self, buf: &[u8], width: u32, height: u32, color_type: ExtendedColorType, ) -> ImageResult<()>

Writes all the bytes in an image to the encoder.

fn set_icc_profile( &mut self, icc_profile: Vec<u8>, ) -> Result<(), UnsupportedError>

Set the ICC profile to use for the image.

fn set_exif_metadata(&mut self, exif: Vec<u8>) -> Result<(), UnsupportedError>

Set the EXIF metadata to use for the image.