searchcraft 0.1.0

Async Rust client for the Searchcraft search API
Documentation 
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

//! Health check endpoint.

use reqwest::Method;

use crate::client::SearchcraftClient;
use crate::config::Operation;
use crate::error;

use super::types::HealthCheckResponse;

impl SearchcraftClient {
    /// Checks that the Searchcraft instance is reachable and healthy.
    ///
    /// A healthy node reports `"ok"` in
    /// [`HealthCheckResponse::data`](super::types::HealthCheckResponse::data).
    ///
    /// `GET /healthcheck`
    ///
    /// # Errors
    ///
    /// Returns [`Error::Configuration`](crate::Error::Configuration) if no read
    /// key is configured, or [`Error::Network`](crate::Error::Network) if the
    /// instance is unreachable.
    pub async fn health_check(&self) -> error::Result<HealthCheckResponse> {
        self.transport
            .request(Method::GET, "healthcheck", Operation::Read, None::<&()>)
            .await
    }
}