1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109

//! Utility Structs for deserialising solr responses
//!
//! This module contains a set of structs that you can use to deserialise common solr responses.
//!
//! As the SolrResponseHeader is frequently reused, this is split out into it's own struct, and
//! composed into other types (eg. in SolrSelectType and SolrUpdateType).

use serde::{Deserialize, Serialize};
use std::collections::HashMap;
use std::fmt;
use std::fmt::{Debug, Display};

//
// Generic/Common Structs
//
/// Struct to match the standard solr responseHeader
///
/// This is typically used as part of SolrRequest::call<T>() as part of a more complex response
/// type.
#[derive(Serialize, Deserialize, Clone, Debug, Eq, PartialEq)]
pub struct SolrResponseHeader {
    pub status: u32,
    pub QTime: u32,
    pub params: Option<HashMap<String, String>>,
    pub rf: Option<u32>,
    pub zkConnected: Option<bool>,
}

impl fmt::Display for SolrResponseHeader {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "{:#?}", self)
    }
}

/// Struct to match the standard solr select body
///
/// This does not specify the actual structure of the returned documents, hence the need to
/// parametrise this struct
#[derive(Serialize, Deserialize, Clone, Debug, PartialEq)]
pub struct SolrSelectBody<T: Debug> {
    pub numFound: u32,
    pub start: u32,
    pub maxScore: Option<f32>,
    pub docs: Vec<T>,
}

impl<T> fmt::Display for SolrSelectBody<T>
where
    T: Display + Debug,
{
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(
            f,
            "numFound: {},\nstart: {},\nmaxScore: {:?}\ndocs: {:?}",
            self.numFound, self.start, self.maxScore, self.docs
        )
    }
}

//
// Output Structs for more specialised use-cases
//
/// Standard structure for a full select response
#[derive(Serialize, Deserialize, Clone, Debug, PartialEq)]
pub struct SolrSelectType<T: Debug> {
    pub responseHeader: SolrResponseHeader,
    pub response: SolrSelectBody<T>,
    pub debug: Option<String>,
}

impl<T> fmt::Display for SolrSelectType<T>
where
    T: Display + Debug,
{
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(
            f,
            "responseHeader: {}, response: {}, debug: {:?}",
            self.responseHeader, self.response, self.debug
        )
    }
}

/// Standard structure for an update response
#[derive(Serialize, Deserialize, Clone, Debug, Eq, PartialEq)]
pub struct SolrUpdateType {
    pub responseHeader: SolrResponseHeader,
    pub debug: Option<String>,
}

impl fmt::Display for SolrUpdateType {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "{:#?}", self)
    }
}

/// Standard structure for a call to /admin/collections?action=LIST
#[derive(Serialize, Deserialize, Clone, Debug, Eq, PartialEq)]
pub struct SolrListCollectionsType {
    pub responseHeader: SolrResponseHeader,
    pub collections: Vec<String>,
    pub debug: Option<String>,
}

impl fmt::Display for SolrListCollectionsType {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "{:#?}", self)
    }
}