Struct UnitsServiceAsyncClient

pub struct UnitsServiceAsyncClient<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> UnitsServiceAsyncClient<T>

where T: AsyncClient,

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

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

pub async 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 async 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> AsyncService<T> for UnitsServiceAsyncClient<T>

where T: AsyncClient,

fn new(client: T) -> Self

Creates a new service wrapping an async HTTP client.

impl<T: Clone> Clone for UnitsServiceAsyncClient<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for UnitsServiceAsyncClient<T>

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

Formats the value using the given formatter.