Struct png::text_metadata::ZTXtChunk

pub struct ZTXtChunk {
    pub keyword: String,
    text: OptCompressed,
}

Struct representing a zTXt chunk

Fields

keyword: String

Keyword field of the tEXt chunk. Needs to be between 1-79 bytes when encoded as Latin-1.

text: OptCompressed

Text field of zTXt chunk. It is compressed by default, but can be uncompressed if necessary.

Implementations

impl ZTXtChunk

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

Creates a new ZTXt chunk.

pub(crate) fn decode( keyword_slice: &[u8], compression_method: u8, text_slice: &[u8], ) -> Result<Self, TextDecodingError>

pub fn decompress_text(&mut self) -> Result<(), DecodingError>

Decompresses the inner text, mutating its own state. Can only handle decompressed text up to DECOMPRESSION_LIMIT bytes.

pub fn decompress_text_with_limit( &mut self, limit: usize, ) -> Result<(), DecodingError>

Decompresses the inner text, mutating its own state. Can only handle decompressed text up to limit bytes.

pub fn get_text(&self) -> Result<String, DecodingError>

Decompresses the inner text, and returns it as a String. If decompression uses more the 2MiB, first call decompress with limit, and then this method.

pub fn compress_text(&mut self) -> Result<(), EncodingError>

Compresses the inner text, mutating its own state.

Trait Implementations

impl Clone for ZTXtChunk

fn clone(&self) -> ZTXtChunk

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ZTXtChunk

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

Formats the value using the given formatter.

impl EncodableTextChunk for ZTXtChunk

fn encode<W: Write>(&self, w: &mut W) -> Result<(), EncodingError>

Encode text chunk as Vec<u8> to a Write

impl PartialEq for ZTXtChunk

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Eq for ZTXtChunk

impl StructuralPartialEq for ZTXtChunk