Enum ResourceLocator 

#[non_exhaustive]
pub enum ResourceLocator {
    Text {
        byte_start: u64,
        byte_end: u64,
        line_start: Option<u64>,
        line_end: Option<u64>,
    },
    PageText {
        page: u32,
        byte_start: u64,
        byte_end: u64,
        text_version: String,
        page_text_hash: String,
    },
    Page {
        page: u32,
    },
    Time {
        start_ms: u64,
        end_ms: u64,
    },
    ImageRegion {
        x: u32,
        y: u32,
        width: u32,
        height: u32,
    },
    WholeResource,
}

Where inside a resource a hit was found. Deliberately modality-independent.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Text

A byte range of a text resource. Lines are 1-based and inclusive.

Fields

byte_start: u64

byte_end: u64

line_start: Option<u64>

line_end: Option<u64>

PageText

UTF-8 range within deterministic extracted text of a 1-based physical page.

Fields

page: u32

byte_start: u64

byte_end: u64

text_version: String

page_text_hash: String

Page

A page of a paged document (reserved for PDF and similar).

Fields

page: u32

Time

A time window of an audio or video resource.

Fields

start_ms: u64

end_ms: u64

ImageRegion

Rectangle in original-image pixels. Origin is top-left; x grows right, y grows down. Reserved: no current provider produces this locator.

Fields

x: u32

y: u32

width: u32

height: u32

WholeResource

The resource as a whole, for example a single image.

Implementations

impl ResourceLocator

pub fn kind(&self) -> &'static str

Stable wire kind used for returned-hit counts.

Trait Implementations

impl Clone for ResourceLocator

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 ResourceLocator

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ResourceLocator

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for ResourceLocator

impl PartialEq for ResourceLocator

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ResourceLocator

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ResourceLocator