Struct png::text_metadata::ITXtChunk

pub struct ITXtChunk {
    pub keyword: String,
    pub compressed: bool,
    pub language_tag: String,
    pub translated_keyword: String,
    text: OptCompressed,
}

Struct encoding an iTXt chunk

Fields

keyword: String

The keyword field. This needs to be between 1-79 bytes when encoded as Latin-1.

compressed: bool

Indicates whether the text will be (or was) compressed in the PNG.

language_tag: String

A hyphen separated list of languages that the keyword is translated to. This is ASCII-7 encoded.

translated_keyword: String

Translated keyword. This is UTF-8 encoded.

text: OptCompressed

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

Implementations

impl ITXtChunk

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

Constructs a new iTXt chunk. Leaves all but keyword and text to default values.

pub(crate) fn decode( keyword_slice: &[u8], compression_flag: u8, compression_method: u8, language_tag_slice: &[u8], translated_keyword_slice: &[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 takes more than 2 MiB, try decompress_text_with_limit followed by this method.

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

Compresses the inner text, mutating its own state.

Trait Implementations

impl Clone for ITXtChunk

fn clone(&self) -> ITXtChunk

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ITXtChunk

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

Formats the value using the given formatter.

impl EncodableTextChunk for ITXtChunk

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

Encode text chunk as Vec<u8> to a Write

impl PartialEq for ITXtChunk

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

impl StructuralPartialEq for ITXtChunk