Struct MicroAsset 

pub struct MicroAsset { /* private fields */ }

An emoji-sized inline image or animation.

use rich_micro::{CellSize, MicroAsset};

let asset = MicroAsset::new("status/ok", "green check mark")?
    .with_emoji("✅")?
    .with_text("OK")?;
assert_eq!(asset.size(), CellSize::default()); // 2x1
assert!(MicroAsset::new("status/ok", "check")?.with_size(CellSize::new(1, 1)?)?.with_emoji("✅").is_err());

Implementations

impl MicroAsset

pub fn new(name: &str, alt: &str) -> Result<Self, MicroError>

A static 2×1 asset with no images, in the inline layer. alt is mandatory: it is what screen readers, logs and plain exports show.

pub fn with_size(self, size: CellSize) -> Result<Self, MicroError>

Change the size; the fallbacks set so far must still fit.

pub fn with_emoji(self, emoji: &str) -> Result<Self, MicroError>

An emoji to show where no image can be drawn.

pub fn with_text(self, text: &str) -> Result<Self, MicroError>

A short text to show where neither an image nor emoji can be.

pub fn with_kind(self, kind: AssetKind) -> Self

pub fn with_variants(self, variants: Variants) -> Self

pub fn with_alias(self, alias: &str) -> Result<Self, MicroError>

Another name for this asset, resolved within its layer.

pub fn with_origin(self, origin: Origin) -> Self

pub fn with_version(self, version: &str) -> Self

pub fn with_license(self, license: &str) -> Self

pub fn with_author(self, author: &str) -> Self

pub fn validate(&self) -> Result<(), MicroError>

Check what the builder methods cannot check one at a time: an animated asset needs an animation or frames.

pub fn name(&self) -> &str

pub fn kind(&self) -> AssetKind

pub fn size(&self) -> CellSize

pub fn cols(&self) -> usize

Its width in cells: what it always measures, however it is drawn.

pub fn rows(&self) -> usize

Its height in rows: 1, or 2 for an asset that reserves the row below its line.

pub fn variants(&self) -> &Variants

pub fn alt(&self) -> &str

pub fn fallback(&self) -> &Fallback

pub fn aliases(&self) -> &[String]

pub fn origin(&self) -> &Origin

pub fn version(&self) -> Option<&str>

pub fn license(&self) -> Option<&str>

pub fn author(&self) -> Option<&str>

pub fn read_variant( &self, image: &ImageRef, limits: &Limits, ) -> Result<Vec<u8>, MicroError>

Read one of this asset’s images from its package, under limits. Errors when the asset has no package or the file changed and now breaks a limit.

Trait Implementations

impl Clone for MicroAsset

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MicroAsset

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

Formats the value using the given formatter.

impl Eq for MicroAsset

impl Hash for MicroAsset

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for MicroAsset

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for MicroAsset