rustyphoenixrequest 1.6.1

This library provides methods to mock request API. This is the Rust equivalent of https://gitlab.in2p3.fr/CTA-LAPP/PHOENIX_LIBS2/network/PhoenixRequest
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
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153

/***************************************
	Auteur : Pierre Aubert
	Mail : pierre.aubert@lapp.in2p3.fr
	Licence : CeCILL-C
****************************************/

use crate::pmimetype::PMimeType;

#[derive(Debug, Default)]
pub struct PRequestParam {
	///Command of the request (i.e. GET)
	command: String,
	///Url of the request (i.e. /)
	url: String,
	///Protocol of the request (i.e. HTTP/1.1)
	protocol: String,
}

impl PRequestParam {
	///Set the command of the PRequestParam
	/// # Parameters
	/// - `command` : command of the request (i.e. GET)
	pub fn set_command(&mut self, command: &String) {
		self.command = command.to_string();
	}
	///Set the url of the PRequestParam
	/// # Parameters
	/// - `url` : url of the request (i.e. /)
	pub fn set_url(&mut self, url: &String) {
		self.url = url.to_string();
	}
	///Set the protocol of the PRequestParam
	/// # Parameters
	/// - `protocol` : protocol of the request (i.e. HTTP/1.1)
	pub fn set_protocol(&mut self, protocol: &String) {
		self.protocol = protocol.to_string();
	}
	///Get the url of the PRequestParam
	/// # Returns
	/// url of the request (i.e. /)
	pub fn get_url(&self) -> &String {
		&self.url
	}
	///Get the command of the PRequestParam
	/// # Returns
	/// command of the request (i.e. /)
	pub fn get_command(&self) -> &String {
		&self.command
	}
	///Get the protocol of the PRequestParam
	/// # Returns
	/// protocol of the request (i.e. /)
	pub fn get_protocol(&self) -> &String {
		&self.protocol
	}
}


#[derive(Debug, Default)]
pub struct PResponseParam {
	///Status of the response (i.e. HTTP/1.1 200 OK)
	pub status: String,
	///Type of the content string
	pub mimetype: PMimeType,
	///Content of the response (i.e. some html page)
	pub content: String,
}

impl PResponseParam {
	///Constructor of the PResponseParam
	/// # Parameters
	/// - `status` : status of the response (i.e. HTTP/1.1 200 OK)
	/// - `mimetype` : type of the content string
	/// - `content` : content of the response (i.e. some html page)
	pub fn new(status: String, mimetype: PMimeType, content: &String) -> Self{
		PResponseParam {
			status: status,
			mimetype: mimetype,
			content: content.to_owned()
		}
	}
	///Set the status of the PResponseParam
	/// # Parameters
	/// - `status` : status of the request (i.e. GET)
	pub fn set_status(&mut self, status: &String) {
		self.status = status.to_string();
	}
	///Set the content of the PResponseParam
	/// # Parameters
	/// - `content` : content of the response (i.e. GET)
	pub fn set_content(&mut self, content: &String) {
		self.content = content.to_string();
	}
	///Set the mime type of the response
	/// # Parameters
	/// - `mimetype` : type of the content of the response
	pub fn set_mime_type(&mut self, mimetype: &PMimeType){
		self.mimetype = *mimetype;
	}
}

pub trait PhoenixRequestStream {
	///Recieved a request from a client
	/// # Parameters
	/// - `request` : PRequestParam recievred from the client
	/// # Returns
	/// corresponding request
	fn recv_request(&mut self, request: &mut PRequestParam) -> bool;

	///Send response to the client
	/// # Returns
	/// corresponding request
	fn send_response(&mut self, response: &PResponseParam);
}

pub trait PhoenixRequestMockStream {
	///Set the record mode in the mock
	/// # Parameters
	/// - `is_mock_record` - true if the mock is in record mode
	fn set_is_record(&mut self, is_mock_record: bool);

	///Set the prefix of the current mock
	/// # Parameters
	/// - `prefix` - prefix of the current mock
	fn set_prefix(&mut self, prefix: &String);
}

pub trait PhoenixRequestServer {
	type Stream;
	///Initialise the Request server
	/// # Parameters
	/// - `hostname` : address of the server
	/// - `port` : port of the server
	/// # Returns
	/// initialised Request server
	fn new(hostname: &String, port: u16) -> Self;
	///Accept the connection and get a corresponding stream
	/// # Returns
	/// corresponding stream
	fn accept(&self) -> Self::Stream;
}

pub trait PhoenixRequestMockServer {
	///Set the record mode in the mock
	/// # Parameters
	/// - `is_mock_record` - true if the mock is in record mode
	fn set_is_record(&mut self, is_mock_record: bool);

	///Set the prefix of the current mock
	/// # Parameters
	/// - `prefix` - prefix of the current mock
	fn set_prefix(&mut self, prefix: &String);
}