Struct png::text_metadata::ZTXtChunk

source ·
pub struct ZTXtChunk {
    pub keyword: String,
    /* private fields */
}
Expand description

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.

Implementations§

source§

impl ZTXtChunk

source

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

Creates a new ZTXt chunk.

source

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.

source

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.

source

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.

source

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

Compresses the inner text, mutating its own state.

Trait Implementations§

source§

impl Clone for ZTXtChunk

source§

fn clone(&self) -> ZTXtChunk

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for ZTXtChunk

source§

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

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

impl EncodableTextChunk for ZTXtChunk

source§

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

Encode text chunk as Vec<u8> to a Write
source§

impl PartialEq for ZTXtChunk

source§

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

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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.
source§

impl Eq for ZTXtChunk

source§

impl StructuralPartialEq for ZTXtChunk

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§

default unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. 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,

§

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>,

§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

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

§

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.