Struct DocReference 

pub struct DocReference {
    pub title: String,
    pub url: String,
    pub relevance: f32,
    pub excerpt: Option<String>,
}

Documentation reference

Fields

title: String

Document title

url: String

URL to the documentation

relevance: f32

Relevance score (0.0 - 1.0)

excerpt: Option<String>

Brief excerpt from the doc

Implementations

impl DocReference

pub fn new(title: impl Into<String>, url: impl Into<String>) -> Self

Create a new documentation reference

pub fn with_relevance(self, relevance: f32) -> Self

Set relevance score

pub fn with_excerpt(self, excerpt: impl Into<String>) -> Self

Set excerpt

Trait Implementations

impl Clone for DocReference

fn clone(&self) -> DocReference

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DocReference

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DocReference

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for DocReference

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

where __S: Serializer,

Serialize this value into the given Serde serializer.