Skip to main content

PngMetadata

Struct PngMetadata 

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

The text entries of a PNG file (matplotlib’s PNG metadata): any keywords, PNG’s own being Title, Author, Description, Copyright, Creation Time, Software, Disclaimer, Warning, Source and Comment. They are written in order as tEXt chunks, or as iTXt chunks when the text is not Latin-1, as Pillow writes them.

matplotlib merges the metadata dictionary over its default Software entry and leaves out the keys set to None; PngMetadata::with and PngMetadata::without do the same.

use pltrs_render::PngMetadata;
// matplotlib's `metadata={"Title": "Signal", "Software": None}`.
let png = PngMetadata::default().with("Title", "Signal").without("Software");
assert_eq!(png.entries(), [("Title".to_owned(), "Signal".to_owned())]);
let defaults = PngMetadata::default();
assert_eq!(defaults.entries()[0].0, "Software");

Implementations§

Source§

impl PngMetadata

Source

pub const fn none() -> Self

No entry at all.

Source

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

These entries with keyword set to text: in place when the keyword has an entry, else as a new last entry (a key of matplotlib’s metadata).

Source

pub fn without(self, keyword: &str) -> Self

These entries without keyword (a key of matplotlib’s metadata set to None).

Source

pub fn entries(&self) -> &[(String, String)]

The keywords and texts, in file order.

Source

pub fn apply_to(&self, encoder: Encoder) -> Encoder

encoder writing these entries as text chunks, in order.

Trait Implementations§

Source§

impl Clone for PngMetadata

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 PngMetadata

Source§

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

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

impl Default for PngMetadata

Source§

fn default() -> Self

The Software entry naming pltrs (PNG_SOFTWARE), as matplotlib names itself.

Source§

impl Eq for PngMetadata

Source§

impl PartialEq for PngMetadata

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 PngMetadata

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.