sendblue 0.5.0

SendBlue is a Rust library that provides an API client for interacting with the SendBlue REST API, enabling businesses to integrate iMessage and SMS services into their applications.
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

//! URL Trait
//!
//! This module provides a trait for handling URLs with default implementations for common operations.

use url::Url as RawUrl;
use validator::ValidationError;

/// A trait for handling URLs with default implementations for common operations.
///
/// # Methods
///
/// * `new` - Creates a new instance of the implementing type from a URL string.
/// * `as_str` - Returns the URL as a string slice.
/// * `url` - Returns a reference to the `RawUrl`.
pub trait Url: Sized {
    /// Creates a new instance of the implementing type from a URL string.
    ///
    /// # Arguments
    ///
    /// * `url` - A string slice that holds the URL.
    ///
    /// # Errors
    ///
    /// Returns a `ValidationError` if the URL is invalid.
    fn new(url: &str) -> Result<Self, ValidationError> {
        let raw_url = RawUrl::parse(url).map_err(|_| ValidationError::new("invalid url format"))?;
        Ok(Self::from_raw_url(raw_url))
    }

    /// Returns the URL as a string slice.
    fn as_str(&self) -> &str {
        self.url().as_str()
    }

    /// Returns a reference to the `RawUrl`.
    fn url(&self) -> &RawUrl {
        self.raw_url()
    }

    /// Creates a new instance of the implementing type from a `RawUrl`.
    ///
    /// # Arguments
    ///
    /// * `raw_url` - A `RawUrl` instance.
    fn from_raw_url(raw_url: RawUrl) -> Self;

    /// Returns a reference to the `RawUrl`.
    ///
    /// This method must be implemented by the type.
    fn raw_url(&self) -> &RawUrl;
}