blueprint-core 0.2.0-alpha.2

//! Types and traits for extracting data from requests.
//!
//! See [`blueprint_sdk::extract`] for more details.
//!
//! [`blueprint_sdk::extract`]: https://docs.rs/blueprint_sdk/latest/blueprint_sdk/extract/index.html

use crate::JobCall;
use crate::job::call::Parts;
use crate::job::result::IntoJobResult;
use core::convert::Infallible;

pub mod rejection;

mod context;
mod extension;
mod from_ref;
mod job_call_parts;
mod job_id;
mod metadata;
mod option;
mod tuple;

pub use self::{
    context::Context,
    extension::{Extension, ExtensionNotFound},
    from_ref::FromRef,
    job_id::JobId,
    metadata::Metadata,
    option::{OptionalFromJobCall, OptionalFromJobCallParts},
    rejection::InvalidUtf8,
};

mod private {
    #[derive(Debug, Clone, Copy)]
    pub enum ViaParts {}

    #[derive(Debug, Clone, Copy)]
    pub enum ViaJobCall {}
}

/// Types that can be created from job calls.
///
/// Extractors that implement `FromJobCall` can consume the job call body and can thus only be run
/// once for jobs.
///
/// If your extractor doesn't need to consume the job call body then you should implement
/// [`FromJobCallParts`] and not [`FromJobCall`].
///
/// See [`blueprint_sdk::extract`] for more general docs about extractors.
///
/// [`blueprint_sdk::extract`]: https://docs.rs/blueprint_sdk/latest/blueprint_sdk/extract/index.html
#[diagnostic::on_unimplemented(
    note = "Function argument is not a valid extractor. \nSee `https://docs.rs/blueprint_sdk/latest/blueprint_sdk/extract/index.html` for details"
)]
pub trait FromJobCallParts<Ctx>: Sized {
    /// If the extractor fails it'll use this "rejection" type. A rejection is
    /// a kind of error that can be converted into a job result.
    type Rejection: IntoJobResult;

    /// Perform the extraction.
    fn from_job_call_parts(
        parts: &mut Parts,
        ctx: &Ctx,
    ) -> impl Future<Output = Result<Self, Self::Rejection>> + Send;
}

/// Types that can be created from job calls.
///
/// Extractors that implement `FromJobCall` can consume the job call body and can thus only be run
/// once for jobs.
///
/// If your extractor doesn't need to consume the job call body then you should implement
/// [`FromJobCallParts`] and not [`FromJobCall`].
///
/// See [`blueprint_sdk::extract`] for more general docs about extractors.
///
/// [`blueprint_sdk::extract`]: https://docs.rs/blueprint_sdk/latest/blueprint_sdk/extract/index.html
#[diagnostic::on_unimplemented(
    note = "Function argument is not a valid extractor. \nSee `https://docs.rs/blueprint_sdk/latest/blueprint_sdk/extract/index.html` for details"
)]
pub trait FromJobCall<Ctx, M = private::ViaJobCall>: Sized {
    /// If the extractor fails it'll use this "rejection" type. A rejection is
    /// a kind of error that can be converted into a job result.
    type Rejection: IntoJobResult;

    /// Perform the extraction.
    fn from_job_call(
        call: JobCall,
        ctx: &Ctx,
    ) -> impl Future<Output = Result<Self, Self::Rejection>> + Send;
}

impl<Ctx, T> FromJobCall<Ctx, private::ViaParts> for T
where
    Ctx: Send + Sync,
    T: FromJobCallParts<Ctx>,
{
    type Rejection = <Self as FromJobCallParts<Ctx>>::Rejection;

    async fn from_job_call(call: JobCall, ctx: &Ctx) -> Result<Self, Self::Rejection> {
        let (mut parts, _) = call.into_parts();
        Self::from_job_call_parts(&mut parts, ctx).await
    }
}

impl<Ctx, T> FromJobCallParts<Ctx> for Result<T, T::Rejection>
where
    T: FromJobCallParts<Ctx>,
    Ctx: Send + Sync,
{
    type Rejection = Infallible;

    async fn from_job_call_parts(parts: &mut Parts, ctx: &Ctx) -> Result<Self, Self::Rejection> {
        Ok(T::from_job_call_parts(parts, ctx).await)
    }
}

impl<Ctx, T> FromJobCall<Ctx> for Result<T, T::Rejection>
where
    T: FromJobCall<Ctx>,
    Ctx: Send + Sync,
{
    type Rejection = Infallible;

    async fn from_job_call(call: JobCall, ctx: &Ctx) -> Result<Self, Self::Rejection> {
        Ok(T::from_job_call(call, ctx).await)
    }
}