Struct ArchiverClient 

pub struct ArchiverClient { /* private fields */ }

An Archiver Appliance retrieval service. Cheap to clone; holds no connection state, so it can be shared freely between threads and between several plots.

Implementations

impl ArchiverClient

pub fn new(url: &str) -> Result<Self>

From the URL the user gave, e.g. http://host:17668 or http://host:17668/retrieval/: strips trailing slashes and appends /retrieval unless it already ends so. Only http and https are accepted, plus Phoebus’s pbraw:// (the same service over plain HTTP); a bare host:port gets http://.

pub fn with_timeout_secs(self, secs: u64) -> Self

pub fn base(&self) -> &str

The normalised retrieval base, e.g. http://host:17668/retrieval.

pub fn data_url(&self, q: &Query) -> String

getData.json with from/to as YYYY-MM-DDTHH:MM:SS.mmmZ and every parameter percent-encoded.

pub fn search_url(&self, s: &Search) -> String

bpl/getMatchingPVs?pv=...&limit=N or ?regex=...&limit=N.

pub fn metadata_url(&self, pv: &str) -> String

bpl/getMetadata?pv=....

pub fn version_url(&self) -> String

bpl/getVersion: the appliance’s version, a cheap “are you there”.

pub fn host(&self) -> &str

The host (and port, when given) of the base URL, for display: archappl.diamond.ac.uk or 127.0.0.1:17668.

impl ArchiverClient

pub fn get_data(&self, q: &Query) -> Result<Option<TimeSeries>>

Fetch and decode one PV’s data. Ok(None) when the archiver has no data in the range (a [ ] response); Err(Http{404}) when the PV is not archived. Blocking: call from a worker thread.

pub fn search(&self, s: &Search) -> Result<Vec<String>>

The archived PV names matching s, sorted. Blocking.

pub fn metadata(&self, pv: &str) -> Result<PvInfo>

The PV’s archive type info. Blocking.

pub fn version(&self) -> Result<String>

The appliance’s version (bpl/getVersion), e.g. “Archiver Appliance Version 1.1.0”. Blocking.

Trait Implementations

impl Clone for ArchiverClient

fn clone(&self) -> ArchiverClient

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ArchiverClient

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

Formats the value using the given formatter.

impl Eq for ArchiverClient

impl PartialEq for ArchiverClient

fn eq(&self, other: &ArchiverClient) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for ArchiverClient