snailcrypt 0.3.0

Library to access api.snailcrypt.com
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
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103

/******************************************************************************
  This file is part of snailcrypt.

  Copyright 2023 Richard Bäck <richard.baeck@snailcrypt.com>

  Permission is hereby granted, free of charge, to any person obtaining a copy
  of this software and associated documentation files (the "Software"), to deal
  in the Software without restriction, including without limitation the rights
  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  copies of the Software, and to permit persons to whom the Software is
  furnished to do so, subject to the following conditions:

  The above copyright notice and this permission notice shall be included in all
  copies or substantial portions of the Software.

  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  SOFTWARE.
*******************************************************************************/

pub use crate::{
	client::{ 
		ClientVersion,
		Client,
        V1Client,
        V2Client,
		VersionSelectorClient,
	},
    config::Config,
    util::Analyzer,
};

use std::rc::Rc;

/// This factory produces clients.
///
/// # Examples
///
/// ```
/// use snailcrypt::{
///     client,
///     config,
///     factory,
///     util,
/// };
///
/// use std::rc::Rc;
///
/// let analyzer_factory: factory::AnalyzerFactory = factory::AnalyzerFactory::new();
/// let analyzer: Rc<dyn util::Analyzer> = analyzer_factory.create();
///
/// let config_factory: factory::ConfigFactory = factory::ConfigFactory::new();
/// let config: Rc<dyn config::Config> = config_factory.create();
///
/// let client_factory: factory::ClientFactory = factory::ClientFactory::new(Rc::clone(&analyzer),
///                             Rc::clone(&config));
/// let client: Rc<dyn client::Client> = client_factory.create();
/// ```
#[allow(unused)]
pub struct ClientFactory {
    analyzer: Rc<dyn Analyzer>,
    config: Rc<dyn Config>
}

impl ClientFactory {
    #[allow(unused)]
    pub fn new(analyzer: Rc<dyn Analyzer>,
            config: Rc<dyn Config>) -> ClientFactory {
        return ClientFactory { 
			analyzer: analyzer,
            config: config,
		};
    }

    /// Create a new client object using a specific version.
    pub fn create(&self) -> Rc<dyn Client> {
        return Rc::new(
            VersionSelectorClient::new(
                Rc::clone(self.get_analyzer()),
                Rc::new(
                    V1Client::new(
                        Rc::clone(self.get_analyzer()),
                        Rc::clone(self.get_config()))),
                Rc::new(
                    V2Client::new(
                        Rc::clone(self.get_analyzer()),
                        Rc::clone(self.get_config())))));
    }
    
    /// Get the analyzer.
    pub fn get_analyzer(&self) -> &Rc<dyn Analyzer> {
		return &self.analyzer;
	}
    
    /// Get the configuraton.
    pub fn get_config(&self) -> &Rc<dyn Config> {
		return &self.config
	}
}