Enum Handle

pub enum Handle {
    Path(Id, PathBuf),
    Bytes(Id, Bytes),
    Rgba {
        id: Id,
        width: u32,
        height: u32,
        pixels: Bytes,
    },
}

A handle of some image data.

Variants

Path(Id, PathBuf)

A file handle. The image data will be read from the file path.

Use from_path to create this variant.

Bytes(Id, Bytes)

A handle pointing to some encoded image bytes in-memory.

Use from_bytes to create this variant.

Rgba

A handle pointing to decoded image pixels in RGBA format.

Use from_rgba to create this variant.

Fields

id: Id

The id of this handle.

width: u32

The width of the image.

height: u32

The height of the image.

pixels: Bytes

The pixels.

Implementations

impl Handle

pub fn from_path<T: Into<PathBuf>>(path: T) -> Handle

Creates an image Handle pointing to the image of the given path.

Makes an educated guess about the image format by examining the data in the file.

pub fn from_bytes(bytes: impl Into<Bytes>) -> Handle

Creates an image Handle containing the encoded image data directly.

Makes an educated guess about the image format by examining the given data.

This is useful if you already have your image loaded in-memory, maybe because you downloaded or generated it procedurally.

pub fn from_rgba(width: u32, height: u32, pixels: impl Into<Bytes>) -> Handle

Creates an image Handle containing the decoded image pixels directly.

This function expects the pixel data to be provided as a collection of Bytes of RGBA pixels. Therefore, the length of the pixel data should always be width * height * 4.

This is useful if you have already decoded your image.

pub fn id(&self) -> Id

Returns the unique identifier of the Handle.

Trait Implementations

impl Clone for Handle

fn clone(&self) -> Handle

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Handle

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

Formats the value using the given formatter.

impl From<&Handle> for Handle

fn from(value: &Handle) -> Self

Converts to this type from the input type.

impl From<&Handle> for Image

fn from(handle: &Handle) -> Self

Converts to this type from the input type.

impl<T> From<T> for Handle

where T: Into<PathBuf>,

fn from(path: T) -> Handle

Converts to this type from the input type.

impl PartialEq for Handle

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

impl StructuralPartialEq for Handle