df-consul/src/with_index.rs
2023-02-02 15:47:20 +01:00

85 lines
2 KiB
Rust

use std::fmt::{Debug, Display};
use anyhow::{bail, Result};
use reqwest::Response;
/// Wraps the returned value of an [API call with blocking
/// possibility](https://developer.hashicorp.com/consul/api-docs/features/blocking) with the
/// returned Consul index
pub struct WithIndex<T> {
value: T,
index: usize,
}
impl<T> WithIndex<T> {
/// (for internal use, mostly)
pub fn index_from(resp: &Response) -> Result<WithIndexBuilder<T>> {
let index = match resp.headers().get("X-Consul-Index") {
Some(v) => v.to_str()?.parse::<usize>()?,
None => bail!("X-Consul-Index header not found"),
};
Ok(WithIndexBuilder {
index,
_phantom: Default::default(),
})
}
/// Returns the inner value, discarding the index
pub fn into_inner(self) -> T {
self.value
}
/// Returns the Consul index, to be used in future calls to the same API endpoint to make them
/// blocking
pub fn index(&self) -> usize {
self.index
}
}
impl<T> std::convert::AsRef<T> for WithIndex<T> {
fn as_ref(&self) -> &T {
&self.value
}
}
impl<T> std::borrow::Borrow<T> for WithIndex<T> {
fn borrow(&self) -> &T {
&self.value
}
}
impl<T> std::ops::Deref for WithIndex<T> {
type Target = T;
fn deref(&self) -> &T {
&self.value
}
}
impl<T: Debug> Debug for WithIndex<T> {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
<T as Debug>::fmt(self, f)
}
}
impl<T: Display> Display for WithIndex<T> {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
<T as Display>::fmt(self, f)
}
}
/// (for internal use, mostly)
pub struct WithIndexBuilder<T> {
_phantom: std::marker::PhantomData<T>,
index: usize,
}
impl<T> WithIndexBuilder<T> {
/// (for internal use, mostly)
pub fn value(self, value: T) -> WithIndex<T> {
WithIndex {
value,
index: self.index,
}
}
}