Struct Service 

pub struct Service {
    db: Data,
    services: Arc<OnceServices>,
}

Fields

db: Data

services: Arc<OnceServices>

Implementations

impl Service

pub async fn issue_token( &self, expires: TokenExpires, ) -> Result<(String, DatabaseTokenInfo)>

Issue a new registration token and save it in the database.

pub async fn is_enabled(&self) -> bool

pub fn get_config_tokens(&self) -> HashSet<String>

pub async fn is_token_valid(&self, token: &str) -> Result

pub async fn try_consume(&self, token: &str) -> Result

async fn check(&self, token: &str, consume: bool) -> Result

pub async fn revoke_token(&self, token: &str) -> Result

Try to revoke a valid token.

Note that tokens set in the config file cannot be revoked.

pub fn iterate_tokens(&self) -> impl Stream<Item = ValidToken> + Send + '_

Iterate over all valid registration tokens.

Trait Implementations

impl Service for Service

fn build(args: &Args<'_>) -> Result<Arc<Self>>

Implement the construction of the service instance. Services are generally singletons so expect this to only be called once for a service type. Note that it may be called again after a server reload, but the prior instance will have been dropped first. Failure will shutdown the server with an error.

fn name(&self) -> &str

Return the name of the service. i.e. crate::service::make_name(std::module_path!())

fn worker<'async_trait>( self: Arc<Self>, ) -> Pin<Box<dyn Future<Output = Result> + Send + 'async_trait>>

where Self: 'async_trait,

Implement the service’s worker loop. The service manager spawns a task and calls this function after all services have been built.

fn interrupt<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

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

Interrupt the service. This is sent to initiate a graceful shutdown. The service worker should return from its work loop.

fn clear_cache<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

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

Clear any caches or similar runtime state.

fn memory_usage<'life0, 'life1, 'async_trait>( &'life0 self, _out: &'life1 mut (dyn Write + Send), ) -> Pin<Box<dyn Future<Output = Result> + Send + 'async_trait>>

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

Memory usage report in a markdown string.

fn unconstrained(&self) -> bool

Return true if the service worker opts out of the tokio cooperative budgeting. This can reduce tail latency at the risk of event loop starvation.