Struct ExplanationPreview 

pub struct ExplanationPreview {
    pub block_path: String,
    pub source: Option<SourceSpan>,
    pub text: String,
    pub match_start_char: u32,
    pub match_end_char: u32,
    pub content_ranges: Vec<ExplanationContentRange>,
    pub clipped_before: bool,
    pub clipped_after: bool,
}

One representative literal window, not a replacement IR block or a summary.

Fields

block_path: String

Final IR coordinate rooted at “root” or “sections/sN[/sN…]”; bN selects a block, iN/dN a list/definition item, and rN/cN a table cell. All indices are zero-based; this is not a source/Markdown byte offset.

source: Option<SourceSpan>

Matched block source position, when known (never a substituted entry span).

text: String

Safely projected original text, at most 1024 Unicode scalar values.

match_start_char: u32

Start of the complete match in text, in zero-based Unicode scalars.

match_end_char: u32

Exclusive end of the complete match in text, in Unicode scalars.

content_ranges: Vec<ExplanationContentRange>

Positions of this reported match in an available returned body, not offsets in this clipped window. Empty when the body is unavailable.

clipped_before: bool

The representative window excludes preceding block text.

clipped_after: bool

The representative window excludes following block text.

Trait Implementations

impl Clone for ExplanationPreview

fn clone(&self) -> ExplanationPreview

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ExplanationPreview

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ExplanationPreview

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for ExplanationPreview

impl JsonSchema for ExplanationPreview

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 ExplanationPreview

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ExplanationPreview

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 ExplanationPreview