yosemite 0.5.0

Asynchronous SAMv3 library
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

// 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.

//! Session style.

#![cfg(all(not(feature = "sync"), any(feature = "tokio", feature = "smol")))]

pub use datagram::{Anonymous, Repliable};
pub use primary::Primary;
pub use stream::Stream;

mod datagram;
mod primary;
mod stream;

pub(crate) mod private {
    /// Session parameters.
    pub struct SessionParameters {
        /// Session style.
        pub(crate) style: String,

        /// Session options.
        pub(crate) options: Vec<(String, String)>,
    }

    pub trait SessionStyle {
        /// Create new `SessionStyle` object.
        fn new(
            options: crate::options::SessionOptions,
        ) -> impl std::future::Future<Output = crate::Result<Self>>
        where
            Self: Sized;

        /// Send command to router.
        fn write_command(
            &mut self,
            command: &[u8],
        ) -> impl std::future::Future<Output = crate::Result<()>>;

        /// Read command from router.
        fn read_command(&mut self) -> impl std::future::Future<Output = crate::Result<String>>;

        /// Get `SESSION CREATE` command for this session style.
        fn create_session(&self) -> SessionParameters;
    }
}

/// Session style.
pub trait SessionStyle: private::SessionStyle {}

/// Subsession.
///
/// Implemented for `Stream`, `Anonymous` and `Datagram`.
pub trait Subsession: SessionStyle {
    /// Create new `SessionStyle` object for a subsession.
    ///
    /// This function doesn't establish a TCP connection to the router as the primary session
    /// already has an active connection.
    fn new(
        options: crate::options::SessionOptions,
    ) -> impl std::future::Future<Output = crate::Result<Self>>
    where
        Self: Sized;
}