Struct ocpi::Cpo

pub struct Cpo<DB> where
    DB: Store,  { /* private fields */ }

Cpo implements the CPO role of the OCPI Protocol.

Every module supplies an implementation of it self on this type.

Implementations

impl<DB> Cpo<DB> where
    DB: Store, 

pub fn new(base_url: Url, db: DB, client: Client) -> Self

Creates a new Cpo instance. the base_url must be the url to the base ocpi endpoint. NOT the versions module. This base url will be used to add on each module url. so versions will be appended and the versions module should be served from that path.

Trait Implementations

impl<DB: Clone> Clone for Cpo<DB> where
    DB: Store, 

fn clone(&self) -> Cpo<DB>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Db, M, Tm> CredentialsModule for Cpo<Db> where
    M: Party + Send + 'static,
    Tm: Send + 'static,
    Db: PartyStore<PartyModel = M, TemporaryModel = Tm> + Sync, 

fn credentials_post<'life0, 'async_trait>(
    &'life0 self,
    ctx: Context<Self::TemporaryModel>,
    param: Credential
) -> Pin<Box<dyn Future<Output = Result<Credential>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Provides credentials for the Server to access the Clients system. This is done using the Temporary model. If this the authentication of the provided Credential is succesful

The provided Credentials will be used to create a new Model. The Credentials for this new Model is what is returned.

type PartyModel = M

type TemporaryModel = Tm

fn credentials_get<'life0, 'async_trait>(
    &'life0 self,
    ctx: Context<Self::PartyModel>
) -> Pin<Box<dyn Future<Output = Result<Credential>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

7.2.1. GET Method

fn credentials_put<'life0, 'async_trait>(
    &'life0 self,
    ctx: Context<Self::PartyModel>,
    param: Credential
) -> Pin<Box<dyn Future<Output = Result<Credential>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

7.2.3. PUT Method

fn credentials_delete<'life0, 'async_trait>(
    &'life0 self,
    ctx: Context<Self::PartyModel>
) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

7.2.4. DELETE Method

impl<DB> VersionsModule for Cpo<DB> where
    DB: Store, 

fn versions_get(&self) -> Result<Vec<Version>>

6.1. Version information endpoint

fn versions_get_details(
    &self,
    version_number: VersionNumber
) -> Result<Option<VersionDetails>>

6.2. Version details endpoint