Enum UnavailableReason 

pub enum UnavailableReason {
    NoShapePng,
    UnsupportedTipKind(String),
    Corrupt(String),
    MissingTip {
        uuid: String,
    },
    TooLarge {
        width: u32,
        height: u32,
    },
    OverBudget,
}

Why an entry has no tip.

This enum is not #[non_exhaustive], so a consumer can match every reason. A new reason is a breaking change, so while brushkit is 0.x it ships in a new minor version. An exhaustive match then stops compiling until it handles the new reason.

use brushkit_preview::UnavailableReason;

fn label(reason: &UnavailableReason) -> &'static str {
    match reason {
        UnavailableReason::NoShapePng => "no tip image",
        UnavailableReason::UnsupportedTipKind(_) => "unsupported tip",
        UnavailableReason::Corrupt(_) => "damaged tip",
        UnavailableReason::MissingTip { .. } => "tip missing from the file",
        UnavailableReason::TooLarge { .. } => "tip too large",
        UnavailableReason::OverBudget => "not loaded",
    }
}

Variants

NoShapePng

UnsupportedTipKind(String)

Corrupt(String)

MissingTip

The preset names a sampledData uuid that no sampled tip in the file carries. uuid is that uuid.

Fields

uuid: String

TooLarge

A side over procreate::MAX_PNG_DIMENSION, or a decode over procreate::MAX_ENTRY_BYTES, counted as TipImageError::TooLarge describes.

Fields

width: u32

height: u32

OverBudget

The tip was not returned because it would take the call’s available tips past MAX_PREVIEW_BYTES. Every later entry that has a tip to render is OverBudget too, and its tip is not decoded.

Trait Implementations

impl Clone for UnavailableReason

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 UnavailableReason

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

Formats the value using the given formatter.

impl Eq for UnavailableReason

impl PartialEq for UnavailableReason

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for UnavailableReason