Struct ImageRequest 

#[non_exhaustive]
pub struct ImageRequest<D> {
    pub format: ImageDataFormat,
    pub data: D,
    pub max_decoded_len: u64,
    pub downscale: Option<ImageDownscaleMode>,
    pub mask: Option<ImageMaskMode>,
    pub entries: ImageEntriesMode,
    pub parent: Option<ImageEntryMetadata>,
}

Represent a image load/decode request.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

format: ImageDataFormat

Image data format.

data: D

Image data.

Bytes layout depends on the format, data structure is IpcBytes or IpcReceiver<IpcBytes> in the view API.

max_decoded_len: u64

Maximum allowed decoded size.

View-process will avoid decoding and return an error if the image decoded to BGRA (4 bytes) exceeds this size. This limit applies to the image before the downscale.

downscale: Option<ImageDownscaleMode>

A size constraints to apply after the image is decoded. The image is resized to fit or fill the given size. Optionally generate multiple reduced entries.

If the image contains multiple images selects the nearest reduced alternate that can be downscaled.

If entries requests REDUCED only the alternates smaller than the requested downscale are included.

mask: Option<ImageMaskMode>

Convert or decode the image into a single channel mask (R8).

entries: ImageEntriesMode

Defines what images are decoded from multi image containers.

parent: Option<ImageEntryMetadata>

Image is an entry (or subtree) of this other image.

This value is now used by the view-process, it is just returned with the metadata. This is useful when an already decoded image is requested after a respawn to maintain the original container structure.

Implementations

impl<D> ImageRequest<D>

pub fn new( format: ImageDataFormat, data: D, max_decoded_len: u64, downscale: Option<ImageDownscaleMode>, mask: Option<ImageMaskMode>, ) -> Self

New request.

Trait Implementations

impl<D: Clone> Clone for ImageRequest<D>

fn clone(&self) -> ImageRequest<D>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<D: Debug> Debug for ImageRequest<D>

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

Formats the value using the given formatter.

impl<'de, D> Deserialize<'de> for ImageRequest<D>

where D: Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<D> Serialize for ImageRequest<D>

where D: Serialize,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.