scanii 1.3.0

Minimal-dependency Rust SDK for the Scanii content security API
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
67
68
69
70
71
72

//! Scanii regional API endpoints.

/// Scanii regional API endpoint.
///
/// Use one of the regional constructors for production, or
/// [`ScaniiTarget::from_url`] for local testing against scanii-cli:
///
/// ```
/// use scanii::ScaniiTarget;
/// let t = ScaniiTarget::from_url("http://localhost:4000");
/// ```
///
/// Note: `AUTO` (latency-based routing to `https://api.scanii.com`) is
/// intentionally absent. Explicit regional selection is required for data
/// residency compliance. Other Scanii SDKs that historically defaulted to
/// AUTO are being updated to deprecate it.
///
/// See <https://scanii.github.io/openapi/v22/>.
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct ScaniiTarget {
    pub(crate) url: String,
}

impl ScaniiTarget {
    /// US East (N. Virginia) — `https://api-us1.scanii.com`
    pub fn us1() -> Self {
        Self::from_url("https://api-us1.scanii.com")
    }

    /// EU West (Ireland) — `https://api-eu1.scanii.com`
    pub fn eu1() -> Self {
        Self::from_url("https://api-eu1.scanii.com")
    }

    /// EU Central (Frankfurt) — `https://api-eu2.scanii.com`
    pub fn eu2() -> Self {
        Self::from_url("https://api-eu2.scanii.com")
    }

    /// Asia Pacific (Singapore) — `https://api-ap1.scanii.com`
    pub fn ap1() -> Self {
        Self::from_url("https://api-ap1.scanii.com")
    }

    /// Asia Pacific (Tokyo) — `https://api-ap2.scanii.com`
    pub fn ap2() -> Self {
        Self::from_url("https://api-ap2.scanii.com")
    }

    /// Canada (Central) — `https://api-ca1.scanii.com`
    pub fn ca1() -> Self {
        Self::from_url("https://api-ca1.scanii.com")
    }

    /// Build a [`ScaniiTarget`] from any base URL string.
    ///
    /// Use this for local testing against scanii-cli or other custom
    /// environments:
    ///
    /// ```
    /// use scanii::ScaniiTarget;
    /// let t = ScaniiTarget::from_url("http://localhost:4000");
    /// ```
    pub fn from_url(url: impl Into<String>) -> Self {
        ScaniiTarget { url: url.into() }
    }

    /// The base URL this target points at.
    pub fn url(&self) -> &str {
        &self.url
    }
}