Skip to main content

Encoder

Struct Encoder 

Source
pub struct Encoder { /* private fields */ }
Expand description

Configures and runs PNG encoding.

The defaults match what matplotlib gets from Pillow: zlib level 6 and Strategy::Filtered with Pillow’s adaptive filtering, and no ancillary chunks.

use pltrs_codec::CompressionLevel;
use pltrs_codec::png::{Encoder, FilterStrategy, FilterType, ImageRef};

let pixels = vec![255u8; 64 * 48 * 4];
let png = Encoder::new()
    .compression(CompressionLevel::BEST)
    .filter(FilterStrategy::Fixed(FilterType::Up))
    .dpi(72.0)
    .text("Software", "pltrs")
    .encode(ImageRef::rgba8(64, 48, &pixels)?)?;
assert!(png.starts_with(&pltrs_codec::png::SIGNATURE));

Implementations§

Source§

impl Encoder

Source

pub fn new() -> Self

An encoder with default settings.

Source

pub fn compression(self, level: CompressionLevel) -> Self

Sets the zlib compression level.

Source

pub fn strategy(self, strategy: Strategy) -> Self

Sets the zlib strategy (Pillow’s compress_type; Strategy::Filtered by default).

Source

pub fn filter(self, strategy: FilterStrategy) -> Self

Sets how scanline filters are chosen.

Source

pub fn physical_dimensions(self, dimensions: PhysicalDimensions) -> Self

Writes a pHYs chunk with these dimensions.

Source

pub fn dpi(self, dpi: f64) -> Self

Writes a pHYs chunk for dpi dots per inch, as matplotlib does with the figure’s dpi. An invalid value (see PhysicalDimensions::from_dpi) makes encode fail with EncodeError::InvalidDpi.

Source

pub fn text(self, keyword: impl Into<String>, text: impl Into<String>) -> Self

Adds a text entry, written as tEXt when the text is Latin-1 and as iTXt (UTF-8) otherwise. Keywords are validated by encode.

Source

pub fn encode(&self, image: ImageRef<'_>) -> Result<Vec<u8>, EncodeError>

Encodes image into a complete PNG file.

Trait Implementations§

Source§

impl Clone for Encoder

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Encoder

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Encoder

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl PartialEq for Encoder

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Encoder

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.