Enum ExplanationContentRange 

pub enum ExplanationContentRange {
    BlockText {
        path: Vec<ExplanationBlockStep>,
        start_char: u32,
        end_char: u32,
    },
    DefinitionTerm {
        path: Vec<ExplanationBlockStep>,
        item_index: u32,
        term_index: u32,
        start_char: u32,
        end_char: u32,
    },
}

Half-open Unicode scalar offsets rooted in this response’s original body. The path does not reference the full source document or a preview window.

Variants

BlockText

Safe visible text of a paragraph, preformatted, equation or unsupported leaf.

Fields

path: Vec<ExplanationBlockStep>

Typed path to that leaf, starting at content.block.

start_char: u32

First matched scalar in the leaf text.

end_char: u32

Exclusive end scalar in the same leaf.

DefinitionTerm

Safe visible inline text of exactly one original definition term.

Fields

path: Vec<ExplanationBlockStep>

Typed path to a definition-list block.

item_index: u32

Item in that returned list; an excerpted owner is item zero.

term_index: u32

Index in that item’s terms, independent of form indices.

start_char: u32

First matched scalar in this term.

end_char: u32

Exclusive end scalar in the same term.

Implementations

impl ExplanationContentRange

pub fn resolve<'a>(&self, content: &'a Block) -> Option<ExplanationTextRoot<'a>>

Validated borrowed target rooted in a returned content block. Invalid paths, wrong owner kinds, empty/inverted or out-of-range spans return None. Consumers must not compensate by searching the text again.

pub fn char_range(&self) -> Range<usize>

Half-open scalar range, to be used only after target validation.

Trait Implementations

impl Clone for ExplanationContentRange

fn clone(&self) -> ExplanationContentRange

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ExplanationContentRange

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ExplanationContentRange

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for ExplanationContentRange

impl JsonSchema for ExplanationContentRange

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for ExplanationContentRange

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ExplanationContentRange

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 ExplanationContentRange