reala-subscription 0.0.0

Simple subscription fetcher and parser.
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

//! Subscription in Clash's YAML configuration format.

use std::sync::Arc;

use crate::Error;

#[derive(Debug, Clone)]
#[derive(serde::Deserialize)]
#[serde(tag = "type")]
/// A proxy configuration.
pub(crate) enum Proxy {
    #[serde(rename = "ss")]
    /// Shadowsocks 2017 or 2022.
    Shadowsocks {
        /// The server address.
        server: Arc<str>,

        /// The server port.
        port: u16,

        /// The password
        password: Arc<str>,

        /// The cipher suite.
        cipher: Arc<str>,
    },

    #[serde(other)]
    /// All unknown proxy types.
    Unknown,
}

#[derive(Debug, Clone)]
#[derive(serde::Deserialize)]
pub(crate) struct Config {
    /// Proxies.
    pub(crate) proxies: Vec<Proxy>,
}

impl Config {
    #[inline]
    /// Parses the given Clash configuration YAML string and returns available
    /// [`Proxy`]s.
    ///
    /// The unknown proxy types are filtered out.
    ///
    /// If the configuration contains no valid proxies, `Ok(None)` is returned.
    ///
    /// # Errors
    ///
    /// Yaml parsing errors.
    pub(crate) fn parse(s: &str) -> Result<Self, Error> {
        serde_saphyr::from_str(s).map_err(|_| Error::Parse)
    }
}