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

use crate :: { import::*, WsErr };


/// Indicates the state of a Websocket connection. The only state in which it's valid to send and receive messages
/// is [WsState::Open].
///
/// See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/WebSocket/readyState) for the ready state values.
//
#[ allow( missing_docs ) ]
//
#[ derive( Debug, Clone, Copy, PartialEq, Eq ) ]
//
pub enum WsState
{
	Connecting,
	Open      ,
	Closing   ,
	Closed    ,
}


/// Internally ready state is a u16, so it's possible to create one from a u16. Only 0-3 are valid values.
///
/// See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/WebSocket/readyState) for the ready state values.
//
impl TryFrom<u16> for WsState
{
	type Error = WsErr;

	fn try_from( state: u16 ) -> Result< Self, Self::Error >
	{
		match state
		{
			WebSocket::CONNECTING => Ok ( WsState::Connecting                      ) ,
			WebSocket::OPEN       => Ok ( WsState::Open                            ) ,
			WebSocket::CLOSING    => Ok ( WsState::Closing                         ) ,
			WebSocket::CLOSED     => Ok ( WsState::Closed                          ) ,

			_                     => Err( WsErr::InvalidWsState{ supplied: state } ) ,
		}
	}
}