Trait svc_storage::grpc::server::parcel::rpc_service_server::RpcService

pub trait RpcService: Send + Sync + 'static {
    // Required methods
    fn get_by_id<'life0, 'async_trait>(
        &'life0 self,
        request: Request<Id>
    ) -> Pin<Box<dyn Future<Output = Result<Response<Object>, Status>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn insert<'life0, 'async_trait>(
        &'life0 self,
        request: Request<Data>
    ) -> Pin<Box<dyn Future<Output = Result<Response<Response>, Status>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn update<'life0, 'async_trait>(
        &'life0 self,
        request: Request<UpdateObject>
    ) -> Pin<Box<dyn Future<Output = Result<Response<Response>, Status>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn delete<'life0, 'async_trait>(
        &'life0 self,
        request: Request<Id>
    ) -> Pin<Box<dyn Future<Output = Result<Response<()>, Status>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn search<'life0, 'async_trait>(
        &'life0 self,
        request: Request<AdvancedSearchFilter>
    ) -> Pin<Box<dyn Future<Output = Result<Response<List>, Status>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn is_ready<'life0, 'async_trait>(
        &'life0 self,
        request: Request<ReadyRequest>
    ) -> Pin<Box<dyn Future<Output = Result<Response<ReadyResponse>, Status>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
}

Generated trait containing gRPC methods that should be implemented for use with RpcServiceServer.

Required Methods

fn get_by_id<'life0, 'async_trait>( &'life0 self, request: Request<Id> ) -> Pin<Box<dyn Future<Output = Result<Response<Object>, Status>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Returns a [tonic::Response] containing a parcel Object Takes an id to find the right record to return.

Errors

Returns [tonic::Status] with Code::NotFound if no record is returned from the database

Examples

use svc_storage_client_grpc::{Id, ParcelClient, simple_service::Client};

async fn example () -> Result<(), Box<dyn std::error::Error>> {
   let mut parcel_client = ParcelClient::connect("http://localhost:50051").await?;

   let id = "53acfe06-dd9b-42e8-8cb4-12a2fb2fa693".to_owned();
   match parcel_client
       .get_by_id(tonic::Request::new(Id { id }))
       .await
   {
       Ok(res) => {
         println!("RESPONSE Parcel By ID={:?}", res);
         Ok(())
       },
       Err(e) => Err(Box::new(e))
   }
}

fn insert<'life0, 'async_trait>( &'life0 self, request: Request<Data> ) -> Pin<Box<dyn Future<Output = Result<Response<Response>, Status>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Returns a [tonic::Response] containing a parcel Response object of the inserted record after saving the provided parcel Data

The given data will be validated before insert. A new UUID will be generated by the database and returned as id as part of the returned parcel Response. Any errors found during validation will be added to the ValidationResult.

Errors

Returns Status with Code::Internal if the [tonic::Request] doesn’t contain any data. Returns Status with Code::Internal if any error is returned from a db call.

Examples

use svc_storage_client_grpc::{Id, ParcelClient, simple_service::Client};
use svc_storage_client_grpc::parcel::{Data, ParcelStatus};
use std::time::SystemTime;

async fn example () -> Result<(), Box<dyn std::error::Error>> {
   let mut parcel_client = ParcelClient::connect("http://localhost:50051").await?;

   let itinerary_id = "62fb5d13-2cfe-45e2-b89a-16205d15e811".to_owned();
   println!("Starting insert parcel");
   match parcel_client
   .insert(tonic::Request::new(Data {
       itinerary_id,
       status: ParcelStatus::Enroute as i32
   }))
   .await
   {
       Ok(res) => {
         println!("RESPONSE Parcel Insert={:?}", res);
         Ok(())
       },
       Err(e) => Err(Box::new(e))
   }
}

fn update<'life0, 'async_trait>( &'life0 self, request: Request<UpdateObject> ) -> Pin<Box<dyn Future<Output = Result<Response<Response>, Status>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Returns a [tonic::Response] containing a parcel Response object of the updated record after saving the provided parcel Data

The given data will be validated before insert. Any errors found during validation will be added to the ValidationResult. A field [prost_types::FieldMask] can be provided to restrict updates to specific fields.

Errors

Returns Status with Code::Cancelled if the Request doesn’t contain any data. Returns Status with Code::Internal if any error is returned from a db call. Returns Status with Code::Internal if the provided Id can not be converted to a [uuid::Uuid]. Returns Status with Code::Internal if the resulting Vec<tokio_postgres::Row> data could not be converted into List.

Examples

use svc_storage_client_grpc::{FieldMask, Id, ParcelClient, simple_service::Client};
use svc_storage_client_grpc::parcel::{Data, UpdateObject};

async fn example () -> Result<(), Box<dyn std::error::Error>> {
   let mut parcel_client = ParcelClient::connect("http://localhost:50051").await?;

   let id = "53acfe06-dd9b-42e8-8cb4-12a2fb2fa693".to_owned();
   let response = match parcel_client
       .get_by_id(tonic::Request::new(Id { id: id.clone() }))
       .await
   {
       Ok(res) => {
         println!("RESPONSE Parcel By ID={:?}", res);
         res
       },
       Err(e) => {
           return Err(Box::new(e));
       }
   };

   let parcel = response.into_inner().data.unwrap();
   match parcel_client.update(tonic::Request::new(UpdateObject {
       id,
       data: Some(Data {
           ..parcel
       }),
       mask: Some(FieldMask {
           paths: vec!["data.parcel_id".to_owned()],
       }),
   })).await
   {
       Ok(res) => {
         println!("RESPONSE Parcel Update={:?}", res);
         Ok(())
       },
       Err(e) => Err(Box::new(e))
   }
}

fn delete<'life0, 'async_trait>( &'life0 self, request: Request<Id> ) -> Pin<Box<dyn Future<Output = Result<Response<()>, Status>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Takes an Id to set the matching parcel record as deleted in the database“

Errors

Returns Status with Code::NotFound if no record is returned from the database. Returns Status with Code::Internal if any error is returned from a db call.

Examples

use svc_storage_client_grpc::{Id, ParcelClient, simple_service::Client};

async fn example () -> Result<(), Box<dyn std::error::Error>> {
   let mut parcel_client = ParcelClient::connect("http://localhost:50051").await?;

   let id = "53acfe06-dd9b-42e8-8cb4-12a2fb2fa693".to_owned();
   match parcel_client.delete(tonic::Request::new(Id{id})).await
   {
       Ok(res) => {
         println!("RESPONSE Parcel Delete={:?}", res);
         Ok(())
       },
       Err(e) => Err(Box::new(e))
   }
}

fn search<'life0, 'async_trait>( &'life0 self, request: Request<AdvancedSearchFilter> ) -> Pin<Box<dyn Future<Output = Result<Response<List>, Status>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Search parcels using an advanced filter

This method supports paged results.

Errors

Returns Status with Code::Internal if any error is returned from the db search result. Returns Status with Code::Internal if the resulting Vec<tokio_postgres::Row> data could not be converted into List.

Examples

use svc_storage_client_grpc::{AdvancedSearchFilter, ParcelClient, simple_service::Client};

async fn example () -> Result<(), Box<dyn std::error::Error>> {
   let mut parcel_client = ParcelClient::connect("http://localhost:50051").await?;

   let parcel_id = "a2093c5e-9bbe-4f0f-97ee-276b43fa3759".to_owned();
   let filter = AdvancedSearchFilter::search_equals("parcel_id".to_owned(), parcel_id);

   match parcel_client
       .search(tonic::Request::new(filter))
       .await
   {
       Ok(res) => {
         println!("RESPONSE Parcel Search={:?}", res);
         Ok(())
       },
       Err(e) => Err(Box::new(e))
   }
}

fn is_ready<'life0, 'async_trait>( &'life0 self, request: Request<ReadyRequest> ) -> Pin<Box<dyn Future<Output = Result<Response<ReadyResponse>, Status>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Simple ready check to allow callers to validate the client connection status.

Implementors

impl RpcService for GrpcServer