Struct zipng::Png

#[non_exhaustive]
pub struct Png {
    pub width: u32,
    pub height: u32,
    pub bit_depth: BitDepth,
    pub color_type: ColorType,
    pub pixel_data: Vec<u8>,
    pub palette_data: Option<Vec<u8>>,
    pub transparency_data: Option<Vec<u8>>,
}

In-memory representation of a PNG file’s essential image contents.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

width: u32

height: u32

bit_depth: BitDepth

color_type: ColorType

pixel_data: Vec<u8>

palette_data: Option<Vec<u8>>

transparency_data: Option<Vec<u8>>

Implementations

impl Png

pub fn new(data: &impl ToPng) -> Self

Creates a new Png from the given data.

pub fn write(&self, output: &impl Write) -> Result<usize, panic>

Serializes this Png as a PNG image file.

pub fn read(input: &impl Read) -> Result<Self, panic>

Deserializes a PNG image file into a Png.

pub fn write_vec(&self) -> Result<Vec<u8>, never>

Serializes this Png into a byte vector as a PNG image file.

pub fn read_slice(input: &[u8]) -> Result<Self, never>

Deserialize a PNG image file into a Png from a byte vector.

pub fn set_pixel(&mut self, x: u32, y: u32, color: &[u8]) -> Result<(), ()>

Sets the pixel at the given coordinates to the given color. The required length of the color data may vary depending on the color type and bit depth of the image.

Trait Implementations

impl Clone for Png

fn clone(&self) -> Png

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Png

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

Formats the value using the given formatter.

impl Default for Png

fn default() -> Png

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Png

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>where
    D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for Png

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where
    H: Hasher,
    Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Png

fn cmp(&self, other: &Png) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<Png> for Png

fn eq(&self, other: &Png) -> 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 PartialOrd<Png> for Png

fn partial_cmp(&self, other: &Png) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for Png

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>where
    S: Serializer,

Serialize this value into the given Serde serializer.

impl ToPng for Png

fn to_png(&self) -> Cow<'_, Png>

Returns a reference to this Png.

impl Eq for Png

impl StructuralEq for Png

impl StructuralPartialEq for Png