cot 0.5.0

The Rust web framework for lazy developers.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66

//! This module defines the email transport system for sending emails in Cot.
//!
//! It provides a [`Transport`] trait that can be implemented by different email
//! backends (e.g., SMTP, console). The module also defines error handling for
//! transport operations.
use std::error::Error as StdError;
use std::future::Future;
use std::pin::Pin;

use cot::email::EmailMessageError;
use thiserror::Error;

use crate::email::EmailMessage;
use crate::error::error_impl::impl_into_cot_error;

pub mod console;
pub mod smtp;

const ERROR_PREFIX: &str = "email transport error:";

/// Errors that can occur while sending an email using a transport backend.
#[derive(Debug, Error)]
#[non_exhaustive]
pub enum TransportError {
    /// The underlying transport backend returned an error.
    #[error("{ERROR_PREFIX} transport error: {0}")]
    Backend(Box<dyn StdError + Send + Sync + 'static>),
    /// Failed to build the email message.
    #[error("{ERROR_PREFIX} message build error: {0}")]
    MessageBuildError(#[from] EmailMessageError),
}

impl_into_cot_error!(TransportError);

/// A Convenience alias for results returned by transport operations.
pub type TransportResult<T> = Result<T, TransportError>;

/// A generic asynchronous email transport interface.
///
/// The [`Transport`] trait abstracts over different email transport backends.
/// It provides methods to manage sending email messages asynchronously.
pub trait Transport: Send + Sync + 'static {
    /// Send one or more email messages.
    ///
    /// # Errors
    ///
    /// This method can return an error if there is an issue sending the
    /// messages.
    fn send(&self, messages: &[EmailMessage]) -> impl Future<Output = TransportResult<()>> + Send;
}

pub(crate) trait BoxedTransport: Send + Sync + 'static {
    fn send<'a>(
        &'a self,
        messages: &'a [EmailMessage],
    ) -> Pin<Box<dyn Future<Output = TransportResult<()>> + Send + 'a>>;
}

impl<T: Transport> BoxedTransport for T {
    fn send<'a>(
        &'a self,
        messages: &'a [EmailMessage],
    ) -> Pin<Box<dyn Future<Output = TransportResult<()>> + Send + 'a>> {
        Box::pin(async move { T::send(self, messages).await })
    }
}