Struct Explanation 

pub struct Explanation {
    pub schema: String,
    pub explainer: String,
    pub facet_sources: Vec<FacetSource>,
    pub sides: Vec<Side>,
    pub redaction: Option<Redaction>,
    pub query: Query,
    pub answer: Answer,
    pub truncation: Option<Truncation>,
    pub facts: Vec<Fact>,
}

The record canonical explanation document (spec 040, 3.3).

Fields

schema: String

explainer: String

facet_sources: Vec<FacetSource>

sides: Vec<Side>

redaction: Option<Redaction>

query: Query

answer: Answer

truncation: Option<Truncation>

facts: Vec<Fact>

Implementations

impl Explanation

pub fn validate(&self) -> Result<(), DocumentError>

Checks structure only. Resolution and factual correctness belong to the explainer.

Trait Implementations

impl Clone for Explanation

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 Explanation

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Explanation

fn deserialize<D: Deserializer<'de>>(d: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl Document for Explanation

const SCHEMA: &'static str = schema::EXPLANATION

The schema string this document carries (spec 002, 3.2.1).

const LIMITS: ParseLimits = REPLAY_V1

The limit set its bytes are scanned against (spec 002, 3.2.5).

fn schema(&self) -> &str

The value of the document’s own schema field.

fn parse(bytes: &[u8]) -> Result<Self, DocumentError>

Scan, deserialize and check the schema string.

fn canonical(&self) -> Result<Vec<u8>, CanonicalError>

The canonical bytes (spec 002, 3.3.1).

fn record_canonical(&self) -> Result<Vec<u8>, CanonicalError>

where Self: PartialEq,

The record canonical bytes (spec 004, 5.6): the canonical bytes, with finite fractional numbers written in shortest round-trip form.

fn record_digest(&self) -> Result<ContentDigest, CanonicalError>

where Self: PartialEq,

sha256(SCHEMA || 0x00 || record canonical bytes) (spec 004, 3.1.6). Equal to the identity of an identified document.

impl JsonSchema for Explanation

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 Explanation

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Explanation

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 Explanation