flep 0.2.0

File transfer protocol (FTP) 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
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98

use {Credentials, Error, FileType};
use io::DataTransferMode;
use {server, protocol};

use std::net::SocketAddr;
use std::path::PathBuf;

/// The state of a client.
#[derive(Clone, Debug)]
pub enum Session
{
    /// We need to send them a welcome message.
    PendingWelcome,
    /// We are waiting for (or in the middle of) the user to login.
    Login(Login),
    /// We are connected and logged in as a user.
    Ready(Ready),
}

/// The state of a client that is in the login process.
#[derive(Clone, Debug)]
pub enum Login
{
    /// The client needs to initiate login by sending 'USER <name>'.
    WaitingForUsername,
    /// The client has initiated login, and we are waiting for their password.
    WaitingForPassword {
        username: String,
    },
}

/// The state of a client that is connected and ready for work.
#[derive(Clone, Debug)]
pub struct Ready
{
    /// The credentials of the current user.
    pub credentials: Credentials,
    /// The current working directory.
    pub working_dir: PathBuf,
    /// The current data transfer file mode.
    pub transfer_type: FileType,
    /// Whether the connection is active or passive.
    pub data_transfer_mode: DataTransferMode,

    /// The port given by the `PORT` command.
    /// Can be empty if passive mode is used.
    pub client_addr: Option<SocketAddr>,
    /// The data transfer operations we have queued.
    pub active_transfer: Option<server::Transfer>,
}

impl Session
{
    pub fn expect_ready(&self) -> Result<&Ready, Error> {
        if let Session::Ready(ref ready) = *self {
            Ok(ready)
        } else {
            Err(protocol::Error::from_kind(protocol::ErrorKind::NotLoggedIn.into()).into())
        }
    }

    pub fn expect_ready_mut(&mut self) -> Result<&mut Ready, Error> {
        if let Session::Ready(ref mut ready) = *self {
            Ok(ready)
        } else {
            Err(protocol::Error::from_kind(protocol::ErrorKind::NotLoggedIn.into()).into())
        }
    }

    pub fn expect_login(&self) -> Result<&Login, Error> {
        if let Session::Login(ref login) = *self {
            Ok(login)
        } else {
            // FIXME: return a more appropriate error.
            Err(protocol::Error::from_kind(protocol::ErrorKind::NotLoggedIn.into()).into())
        }
    }
}

impl Ready
{
    /// Creates a new thing.
    pub fn new(credentials: Credentials) -> Self {
        Ready {
            credentials: credentials,
            working_dir: "/".into(),
            transfer_type: FileType::Binary,
            data_transfer_mode: DataTransferMode::default(),
            client_addr: None,
            active_transfer: None,
        }
    }
}

impl Default for Session
{
    fn default() -> Self { Session::PendingWelcome }
}