nominal-api 0.1197.0

// This file is @generated by prost-build.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetAllUnitsResponse {
    #[prost(map = "string, message", tag = "1")]
    pub units_by_property: ::std::collections::HashMap<
        ::prost::alloc::string::String,
        get_all_units_response::GetUnitsResponseUnitsByPropertyWrapper,
    >,
}
/// Nested message and enum types in `GetAllUnitsResponse`.
pub mod get_all_units_response {
    #[derive(Clone, PartialEq, ::prost::Message)]
    pub struct GetUnitsResponseUnitsByPropertyWrapper {
        #[prost(message, repeated, tag = "1")]
        pub value: ::prost::alloc::vec::Vec<super::Unit>,
    }
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Unit {
    #[prost(string, optional, tag = "1")]
    pub name: ::core::option::Option<::prost::alloc::string::String>,
    #[prost(string, tag = "2")]
    pub symbol: ::prost::alloc::string::String,
    /// Empty if no property is available. If two units measure different properties, it is not possible to
    /// convert between them.
    #[prost(string, optional, tag = "3")]
    pub property: ::core::option::Option<::prost::alloc::string::String>,
    /// The physical dimensions in terms of the base units of the system. It is only possible to convert units if
    /// they have the same dimension. Empty if the unit is a base unit.
    #[prost(message, optional, tag = "4")]
    pub dimension: ::core::option::Option<UnitDimension>,
    #[prost(string, tag = "5")]
    pub system: ::prost::alloc::string::String,
}
/// The fundamental base dimensions and their exponents, whose product compose a unit.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct UnitDimension {
    #[prost(map = "string, int32", tag = "1")]
    pub base_dimensions: ::std::collections::HashMap<
        ::prost::alloc::string::String,
        i32,
    >,
}
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct GetAllUnitsRequest {}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetUnitRequest {
    #[prost(string, tag = "1")]
    pub unit: ::prost::alloc::string::String,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetUnitResponse {
    #[prost(message, optional, tag = "1")]
    pub unit: ::core::option::Option<Unit>,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetBatchUnitsRequest {
    #[prost(string, repeated, tag = "1")]
    pub units: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetBatchUnitsResponse {
    #[prost(map = "string, message", tag = "1")]
    pub responses: ::std::collections::HashMap<::prost::alloc::string::String, Unit>,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetCommensurableUnitsRequest {
    #[prost(string, tag = "1")]
    pub unit: ::prost::alloc::string::String,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetCommensurableUnitsResponse {
    #[prost(message, repeated, tag = "1")]
    pub units: ::prost::alloc::vec::Vec<Unit>,
}
/// buf:lint:ignore ENUM_ZERO_VALUE_SUFFIX
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
#[repr(i32)]
pub enum ScoutError {
    CannotDeserializeSearchToken = 0,
    /// The start time of the provided Range is greater than its end time.
    InvalidRange = 1,
    RequestedPageSizeTooLarge = 2,
}
impl ScoutError {
    /// String value of the enum field names used in the ProtoBuf definition.
    ///
    /// The values are not transformed in any way and thus are considered stable
    /// (if the ProtoBuf definition does not change) and safe for programmatic use.
    pub fn as_str_name(&self) -> &'static str {
        match self {
            Self::CannotDeserializeSearchToken => {
                "SCOUT_ERROR_CANNOT_DESERIALIZE_SEARCH_TOKEN"
            }
            Self::InvalidRange => "SCOUT_ERROR_INVALID_RANGE",
            Self::RequestedPageSizeTooLarge => {
                "SCOUT_ERROR_REQUESTED_PAGE_SIZE_TOO_LARGE"
            }
        }
    }
    /// Creates an enum from field names used in the ProtoBuf definition.
    pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
        match value {
            "SCOUT_ERROR_CANNOT_DESERIALIZE_SEARCH_TOKEN" => {
                Some(Self::CannotDeserializeSearchToken)
            }
            "SCOUT_ERROR_INVALID_RANGE" => Some(Self::InvalidRange),
            "SCOUT_ERROR_REQUESTED_PAGE_SIZE_TOO_LARGE" => {
                Some(Self::RequestedPageSizeTooLarge)
            }
            _ => None,
        }
    }
}
/// Generated client implementations.
pub mod units_service_client {
    #![allow(
        unused_variables,
        dead_code,
        missing_docs,
        clippy::wildcard_imports,
        clippy::let_unit_value,
    )]
    use tonic::codegen::*;
    use tonic::codegen::http::Uri;
    /// 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.
    #[derive(Debug, Clone)]
    pub struct UnitsServiceClient<T> {
        inner: tonic::client::Grpc<T>,
    }
    impl UnitsServiceClient<tonic::transport::Channel> {
        /// Attempt to create a new client by connecting to a given endpoint.
        pub async fn connect<D>(dst: D) -> Result<Self, tonic::transport::Error>
        where
            D: TryInto<tonic::transport::Endpoint>,
            D::Error: Into<StdError>,
        {
            let conn = tonic::transport::Endpoint::new(dst)?.connect().await?;
            Ok(Self::new(conn))
        }
    }
    impl<T> UnitsServiceClient<T>
    where
        T: tonic::client::GrpcService<tonic::body::Body>,
        T::Error: Into<StdError>,
        T::ResponseBody: Body<Data = Bytes> + std::marker::Send + 'static,
        <T::ResponseBody as Body>::Error: Into<StdError> + std::marker::Send,
    {
        pub fn new(inner: T) -> Self {
            let inner = tonic::client::Grpc::new(inner);
            Self { inner }
        }
        pub fn with_origin(inner: T, origin: Uri) -> Self {
            let inner = tonic::client::Grpc::with_origin(inner, origin);
            Self { inner }
        }
        pub fn with_interceptor<F>(
            inner: T,
            interceptor: F,
        ) -> UnitsServiceClient<InterceptedService<T, F>>
        where
            F: tonic::service::Interceptor,
            T::ResponseBody: Default,
            T: tonic::codegen::Service<
                http::Request<tonic::body::Body>,
                Response = http::Response<
                    <T as tonic::client::GrpcService<tonic::body::Body>>::ResponseBody,
                >,
            >,
            <T as tonic::codegen::Service<
                http::Request<tonic::body::Body>,
            >>::Error: Into<StdError> + std::marker::Send + std::marker::Sync,
        {
            UnitsServiceClient::new(InterceptedService::new(inner, interceptor))
        }
        /// Compress requests with the given encoding.
        ///
        /// This requires the server to support it otherwise it might respond with an
        /// error.
        #[must_use]
        pub fn send_compressed(mut self, encoding: CompressionEncoding) -> Self {
            self.inner = self.inner.send_compressed(encoding);
            self
        }
        /// Enable decompressing responses.
        #[must_use]
        pub fn accept_compressed(mut self, encoding: CompressionEncoding) -> Self {
            self.inner = self.inner.accept_compressed(encoding);
            self
        }
        /// Limits the maximum size of a decoded message.
        ///
        /// Default: `4MB`
        #[must_use]
        pub fn max_decoding_message_size(mut self, limit: usize) -> Self {
            self.inner = self.inner.max_decoding_message_size(limit);
            self
        }
        /// Limits the maximum size of an encoded message.
        ///
        /// Default: `usize::MAX`
        #[must_use]
        pub fn max_encoding_message_size(mut self, limit: usize) -> Self {
            self.inner = self.inner.max_encoding_message_size(limit);
            self
        }
        /// Returns all known units, grouped by the physical property they measure.
        pub async fn get_all_units(
            &mut self,
            request: impl tonic::IntoRequest<super::GetAllUnitsRequest>,
        ) -> std::result::Result<
            tonic::Response<super::GetAllUnitsResponse>,
            tonic::Status,
        > {
            self.inner
                .ready()
                .await
                .map_err(|e| {
                    tonic::Status::unknown(
                        format!("Service was not ready: {}", e.into()),
                    )
                })?;
            let codec = tonic::codec::ProstCodec::default();
            let path = http::uri::PathAndQuery::from_static(
                "/nominal.units.v1.UnitsService/GetAllUnits",
            );
            let mut req = request.into_request();
            req.extensions_mut()
                .insert(GrpcMethod::new("nominal.units.v1.UnitsService", "GetAllUnits"));
            self.inner.unary(req, path, codec).await
        }
        /// Returns information for a unit symbol if available. Returns as empty if the provided symbol cannot be parsed.
        pub async fn get_unit(
            &mut self,
            request: impl tonic::IntoRequest<super::GetUnitRequest>,
        ) -> std::result::Result<
            tonic::Response<super::GetUnitResponse>,
            tonic::Status,
        > {
            self.inner
                .ready()
                .await
                .map_err(|e| {
                    tonic::Status::unknown(
                        format!("Service was not ready: {}", e.into()),
                    )
                })?;
            let codec = tonic::codec::ProstCodec::default();
            let path = http::uri::PathAndQuery::from_static(
                "/nominal.units.v1.UnitsService/GetUnit",
            );
            let mut req = request.into_request();
            req.extensions_mut()
                .insert(GrpcMethod::new("nominal.units.v1.UnitsService", "GetUnit"));
            self.inner.unary(req, path, codec).await
        }
        /// Returns information for the unit symbols if available. If the provided symbol cannot be parsed, it will be
        /// omitted from the map.
        pub async fn get_batch_units(
            &mut self,
            request: impl tonic::IntoRequest<super::GetBatchUnitsRequest>,
        ) -> std::result::Result<
            tonic::Response<super::GetBatchUnitsResponse>,
            tonic::Status,
        > {
            self.inner
                .ready()
                .await
                .map_err(|e| {
                    tonic::Status::unknown(
                        format!("Service was not ready: {}", e.into()),
                    )
                })?;
            let codec = tonic::codec::ProstCodec::default();
            let path = http::uri::PathAndQuery::from_static(
                "/nominal.units.v1.UnitsService/GetBatchUnits",
            );
            let mut req = request.into_request();
            req.extensions_mut()
                .insert(
                    GrpcMethod::new("nominal.units.v1.UnitsService", "GetBatchUnits"),
                );
            self.inner.unary(req, path, codec).await
        }
        /// 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.
        pub async fn get_commensurable_units(
            &mut self,
            request: impl tonic::IntoRequest<super::GetCommensurableUnitsRequest>,
        ) -> std::result::Result<
            tonic::Response<super::GetCommensurableUnitsResponse>,
            tonic::Status,
        > {
            self.inner
                .ready()
                .await
                .map_err(|e| {
                    tonic::Status::unknown(
                        format!("Service was not ready: {}", e.into()),
                    )
                })?;
            let codec = tonic::codec::ProstCodec::default();
            let path = http::uri::PathAndQuery::from_static(
                "/nominal.units.v1.UnitsService/GetCommensurableUnits",
            );
            let mut req = request.into_request();
            req.extensions_mut()
                .insert(
                    GrpcMethod::new(
                        "nominal.units.v1.UnitsService",
                        "GetCommensurableUnits",
                    ),
                );
            self.inner.unary(req, path, codec).await
        }
    }
}