Struct SpellCheckResult 

pub struct SpellCheckResult {
    pub database: String,
    pub query: String,
    pub corrected_query: String,
    pub spelled_query: Vec<SpelledQuerySegment>,
}

Result from the ESpell API providing spelling suggestions

ESpell provides spelling suggestions for terms within a single text query in a given database. It acts as a preprocessing/spell-check tool to improve search accuracy before executing actual searches.

Example

use pubmed_client::PubMedClient;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = PubMedClient::new();
    let result = client.spell_check("asthmaa OR alergies").await?;
    println!("Original: {}", result.query);
    println!("Corrected: {}", result.corrected_query);
    Ok(())
}

Fields

database: String

The database that was queried

query: String

The original query string as submitted

corrected_query: String

The full corrected/suggested query as a plain string

spelled_query: Vec<SpelledQuerySegment>

Detailed segments showing which terms were replaced vs. kept

Implementations

impl SpellCheckResult

pub fn has_corrections(&self) -> bool

Check if the query had any spelling corrections.

Returns true only when NCBI provided a non-empty corrected query that differs from the original. The NCBI ESpell API returns an empty <CorrectedQuery/> element when no corrections are available.

pub fn replacements(&self) -> Vec<&str>

Get only the replaced (corrected) terms

Trait Implementations

impl Clone for SpellCheckResult

fn clone(&self) -> SpellCheckResult

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SpellCheckResult

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SpellCheckResult

fn deserialize<__D>( __deserializer: __D, ) -> Result<SpellCheckResult, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for SpellCheckResult

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

where __S: Serializer,

Serialize this value into the given Serde serializer.