Enum MediaKind 

pub enum MediaKind {
    Text,
    Image {
        format: String,
    },
    Document {
        pages: u32,
        has_text_layer: bool,
    },
    Binary,
}

What kind of thing a handle refers to, reported by Event::Opened.

A block needs this to know which commands are worth issuing: Command::Slice on a PNG is a mistake, and Command::PageText on a plain text file is meaningless. Reporting it up front means a block can branch on what it actually got rather than guessing from a file extension.

Variants

Text

Valid UTF-8. Both Command::Slice and Command::SliceBytes work.

Image

An image the host recognised. Usable as an Command::Infer image.

Fields

format: String

Format as detected from content, e.g. png, jpeg.

Document

A paged document — a PDF, say.

Fields

pages: u32

How many pages it has.

has_text_layer: bool

Whether it carries an extractable text layer.

False for a scanned document, where the only way to read it is to rasterize pages and hand them to a vision model. A block that checks this can pick the cheap path when it exists and the expensive one when it must, instead of silently extracting nothing.

Binary

Bytes the host could not classify. Only Command::SliceBytes applies.

Trait Implementations

impl Clone for MediaKind

fn clone(&self) -> MediaKind

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MediaKind

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

Formats the value using the given formatter.

impl Default for MediaKind

fn default() -> MediaKind

Text, because that is what every command predating MediaKind assumed, and because it keeps an older block’s behaviour unchanged.

impl<'de> Deserialize<'de> for MediaKind

fn deserialize<__D>( __deserializer: __D, ) -> Result<MediaKind, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for MediaKind

impl PartialEq for MediaKind

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for MediaKind

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for MediaKind