mcai_ftp 3.0.1

FTP client for Rust
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

//! The set of valid values for FTP commands

use std::convert::From;
use std::error::Error;
use std::fmt;

/// A shorthand for a Result whose error type is always an FtpError.
pub type Result<T> = ::std::result::Result<T, FtpError>;

/// `FtpError` is a library-global error type to describe the different kinds of
/// errors that might occur while using FTP.
#[derive(Debug)]
pub enum FtpError {
  ConnectionError(::std::io::Error),
  SecureError(String),
  InvalidResponse(String),
  InvalidAddress(::std::net::AddrParseError),
}

/// Text Format Control used in `TYPE` command
#[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord)]
pub enum FormatControl {
  /// Default text format control (is NonPrint)
  Default,
  /// Non-print (not destined for printing)
  NonPrint,
  /// Telnet format control (\<CR\>, \<FF\>, etc.)
  Telnet,
  /// ASA (Fortran) Carriage Control
  Asa,
}

/// File Type used in `TYPE` command
#[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord)]
pub enum FileType {
  /// ASCII text (the argument is the text format control)
  Ascii(FormatControl),
  /// EBCDIC text (the argument is the text format control)
  Ebcdic(FormatControl),
  /// Image,
  Image,
  /// Binary (the synonym to Image)
  Binary,
  /// Local format (the argument is the number of bits in one byte on local machine)
  Local(u8),
}

/// `Line` contains a command code and the contents of a line of text read from the network.
pub struct Line(pub u32, pub String);

impl ToString for FormatControl {
  fn to_string(&self) -> String {
    match self {
      &FormatControl::Default | &FormatControl::NonPrint => String::from("N"),
      &FormatControl::Telnet => String::from("T"),
      &FormatControl::Asa => String::from("C"),
    }
  }
}

impl ToString for FileType {
  fn to_string(&self) -> String {
    match self {
      &FileType::Ascii(ref fc) => format!("A {}", fc.to_string()),
      &FileType::Ebcdic(ref fc) => format!("E {}", fc.to_string()),
      &FileType::Image | &FileType::Binary => String::from("I"),
      &FileType::Local(ref bits) => format!("L {}", bits),
    }
  }
}

impl fmt::Display for FtpError {
  fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
    match *self {
      FtpError::ConnectionError(ref ioerr) => write!(f, "FTP ConnectionError: {}", ioerr),
      FtpError::SecureError(ref desc) => write!(f, "FTP SecureError: {}", desc.clone()),
      FtpError::InvalidResponse(ref desc) => {
        write!(f, "FTP InvalidResponse: {}", desc.clone())
      }
      FtpError::InvalidAddress(ref perr) => write!(f, "FTP InvalidAddress: {}", perr),
    }
  }
}

impl Error for FtpError {
  fn cause(&self) -> Option<&dyn Error> {
    match *self {
      FtpError::ConnectionError(ref ioerr) => Some(ioerr),
      FtpError::SecureError(_) => None,
      FtpError::InvalidResponse(_) => None,
      FtpError::InvalidAddress(ref perr) => Some(perr),
    }
  }
}