Struct livesplit_core::Image

pub struct Image { /* fields omitted */ }

Images can be used to store segment and game icons. Each image object comes with an ID that changes whenever the image is modified. IDs are unique across different images. You can query the image's data as a Data URL. There's no specific image format you need to use for the images.

Methods

impl Image

pub fn new(data: &[u8]) -> Self

Creates a new image with a unique ID with the image data provided.

pub fn from_file<P, B>(path: P, buf: B) -> Result<Image> where
    P: AsRef<Path>,
    B: AsMut<Vec<u8>>, 

Loads an image from the file system. You need to provide a buffer used for temporarily storing the image's data.

pub fn id(&self) -> usize

Accesses the unique ID for this image.

pub fn url(&self) -> &str

Accesses the Data URL storing the image's data. If the image's data is empty, this returns an empty string instead of a URL.

pub fn modify(&mut self, data: &[u8])

Modifies an image by replacing its image data with the new image data provided. The image's ID changes to a new unique ID.

pub fn is_empty(&self) -> bool

Checks if the image data is empty.

Trait Implementations

impl Default for Image

fn default() -> Image

Returns the "default value" for a type.

impl Clone for Image

fn clone(&self) -> Image

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<D: AsRef<[u8]>> From<D> for Image

fn from(d: D) -> Self

Performs the conversion.

impl PartialEq<Image> for Image

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

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

#[must_use]

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl Debug for Image

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

Formats the value using the given formatter.