Struct UnitsServiceClient

pub struct UnitsServiceClient<T>(/* private fields */);

The Units Service serves as a comprehensive catalog of the units of measurement supported by scout. Units, by default, follow the UCUM convention for representation.

Implementations

impl<T> UnitsServiceClient<T>

where T: Client,

pub fn get_all_units( &self, auth_: &BearerToken, ) -> Result<GetUnitsResponse, Error>

Returns all known units, grouped by the physical property they measure.

pub fn get_unit( &self, auth_: &BearerToken, unit: &UnitSymbol, ) -> Result<Option<Unit>, Error>

Returns information for a unit symbol if available. Returns as empty if the provided symbol cannot be parsed.

pub fn get_batch_units( &self, auth_: &BearerToken, units: &BTreeSet<UnitSymbol>, ) -> Result<BTreeMap<UnitSymbol, Unit>, Error>

Returns information for the unit symbols if available. If the provided symbol cannot be parsed, it will be omitted from the map.

pub fn get_commensurable_units( &self, auth_: &BearerToken, unit: &UnitSymbol, ) -> Result<BTreeSet<Unit>, Error>

Returns the set of cataloged units that can be converted to and from the given unit. No commensurable units does not imply the unit is invalid. Use /get-unit to check for validity.

Trait Implementations

impl<T: Clone> Clone for UnitsServiceClient<T>

fn clone(&self) -> UnitsServiceClient<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for UnitsServiceClient<T>

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

Formats the value using the given formatter.

impl<T> Service<T> for UnitsServiceClient<T>

where T: Client,

fn new(client: T) -> Self

Creates a new service wrapping an HTTP client.