polyester::connect::auth::v1

Trait ApiKeyService

pub trait ApiKeyService:
    Send
    + Sync
    + 'static {
    // Required methods
    fn create_api_key<'a>(
        &'a self,
        ctx: RequestContext,
        request: ServiceRequest<'_, CreateApiKeyRequest>,
    ) -> impl Future<Output = ServiceResult<impl Encodable<CreateApiKeyResponse> + Send + use<'a, Self>>> + Send;
    fn list_api_keys<'a>(
        &'a self,
        ctx: RequestContext,
        request: ServiceRequest<'_, ListApiKeysRequest>,
    ) -> impl Future<Output = ServiceResult<impl Encodable<ListApiKeysResponse> + Send + use<'a, Self>>> + Send;
    fn get_api_key<'a>(
        &'a self,
        ctx: RequestContext,
        request: ServiceRequest<'_, GetApiKeyRequest>,
    ) -> impl Future<Output = ServiceResult<impl Encodable<GetApiKeyResponse> + Send + use<'a, Self>>> + Send;
    fn delete_api_key<'a>(
        &'a self,
        ctx: RequestContext,
        request: ServiceRequest<'_, DeleteApiKeyRequest>,
    ) -> impl Future<Output = ServiceResult<impl Encodable<DeleteApiKeyResponse> + Send + use<'a, Self>>> + Send;
    fn update_api_key<'a>(
        &'a self,
        ctx: RequestContext,
        request: ServiceRequest<'_, UpdateApiKeyRequest>,
    ) -> impl Future<Output = ServiceResult<impl Encodable<UpdateApiKeyResponse> + Send + use<'a, Self>>> + Send;
}

Expand description

ApiKeyService manages API keys for authenticated callers.

§Implementing handlers

Implement methods with plain async fn; the returned future satisfies the Send bound automatically.

Unary and server-streaming requests arrive as ServiceRequest<'_, Req>: a zero-copy view of the request plus its body, valid for the duration of the call. Fields are read directly (request.name is a &str into the decoded buffer) and the borrow may be held across .await points. Anything that must outlive the call — tokio::spawn, channels, server state, or data captured by a returned response stream — takes owned data: call request.to_owned_message() (or copy the specific fields) first.

Client-streaming and bidi requests arrive as InboundStream<Req> — a ServiceStream of StreamMessages. Each item owns its decoded buffer and is Send + 'static, so items can be buffered or moved into spawned tasks; read fields zero-copy through the generated accessor methods (item.name()) or .view(), convert with .to_owned_message(), or yield an item back unchanged — StreamMessage<M> implements Encodable<M>.

Request types resolved through extern_path (e.g. well-known types from another crate) use the same wrappers; the crate that owns the type must be generated with buffa ≥ 0.8.0 and views enabled so the backing HasMessageView impl exists.

The impl Encodable<Out> return bound accepts the owned Out, the generated OutView<'_> / OwnedOutView, MaybeBorrowed, or PreEncoded for handlers that encode a non-'static view internally and pass the bytes across the handler boundary. View bodies are not emitted for output types mapped via extern_path (the impl would be an orphan); return owned for WKT/extern outputs.

Server-streaming and bidi-streaming methods return ServiceStream<impl Encodable<Out> + Send + use<Self>>. The use<Self> precise-capturing clause excludes &self’s lifetime and the request’s lifetime (unary methods use use<'a, Self> and may borrow from &self), so stream items must be 'static and cannot borrow from the request. To stream view-encoded data, encode each item inside the stream body and yield PreEncoded — see its # Streaming example doc.

Required Methods§

Source

fn create_api_key<'a>( &'a self, ctx: RequestContext, request: ServiceRequest<'_, CreateApiKeyRequest>, ) -> impl Future<Output = ServiceResult<impl Encodable<CreateApiKeyResponse> + Send + use<'a, Self>>> + Send

Create a new API key for the caller. Account security settings may require MFA enrollment or a fresh step-up proof.