Struct Image 

pub struct Image<'a> { /* private fields */ }

A JPEG2000 image or codestream.

Implementations

impl<'a> Image<'a>

pub fn new(data: &'a [u8], settings: &DecodeSettings) -> Result<Self>

Try to create a new JPEG2000 image from the given data.

pub fn has_alpha(&self) -> bool

Whether the image has an alpha channel.

pub fn color_space(&self) -> &ColorSpace

The color space of the image.

pub fn width(&self) -> u32

The width of the image.

pub fn height(&self) -> u32

The height of the image.

pub fn original_bit_depth(&self) -> u8

The original bit depth of the image. You usually don’t need to do anything with this parameter, it just exists for informational purposes.

pub fn decode(&self) -> Result<Vec<u8>>

Decode the image and return its decoded result as a Vec<u8>, with each channel interleaved.

pub fn decode_into( &'a self, buf: &mut [u8], decoder_context: &mut DecoderContext<'a>, ) -> Result<()>

Decode the image into the given buffer.

This method does the same as Image::decode, but you can provide a custom buffer for the output, as well as a decoder context. Doing so will allow hayro-jpeg2000 to reuse memory allocations, so this is especially recommended if you plan on converting multiple images in the same session.

The buffer must have the correct size.

Trait Implementations

impl ImageDecoder for Image<'_>

fn dimensions(&self) -> (u32, u32)

Returns a tuple containing the width and height of the image

fn color_type(&self) -> ColorType

Returns the color type of the image data produced by this decoder

fn original_color_type(&self) -> ExtendedColorType

Returns the color type of the image file before decoding

fn read_image(self, buf: &mut [u8]) -> ImageResult<()>

where Self: Sized,

Returns all the bytes in the image.

fn read_image_boxed(self: Box<Self>, buf: &mut [u8]) -> ImageResult<()>

Use read_image instead; this method is an implementation detail needed so the trait can be object safe.

fn icc_profile(&mut self) -> Result<Option<Vec<u8>>, ImageError>

Returns the ICC color profile embedded in the image, or Ok(None) if the image does not have one.

fn exif_metadata(&mut self) -> Result<Option<Vec<u8>>, ImageError>

Returns the raw Exif chunk, if it is present. A third-party crate such as kamadak-exif is required to actually parse it.

fn xmp_metadata(&mut self) -> Result<Option<Vec<u8>>, ImageError>

Returns the raw XMP chunk, if it is present. A third-party crate such as roxmltree is required to actually parse it.

fn iptc_metadata(&mut self) -> Result<Option<Vec<u8>>, ImageError>

Returns the raw IPTC chunk, if it is present.

fn orientation(&mut self) -> Result<Orientation, ImageError>

Returns the orientation of the image.

fn total_bytes(&self) -> u64

Returns the total number of bytes in the decoded image.

fn set_limits(&mut self, limits: Limits) -> Result<(), ImageError>

Set the decoder to have the specified limits. See Limits for the different kinds of limits that is possible to set.