Struct FtpStream

pub struct FtpStream { /* private fields */ }

Stream to interface with the FTP server. This interface is only for the command stream.

Implementations

impl FtpStream

pub async fn connect<A: ToSocketAddrs>(addr: A) -> Result<FtpStream>

Creates an FTP Stream.

pub fn get_ref(&self) -> &TcpStream

Returns a reference to the underlying TcpStream.

Example:

use tokio::net::TcpStream;
use std::time::Duration;
use async_ftp::FtpStream;

async {
  let stream = FtpStream::connect("172.25.82.139:21").await
                         .expect("Couldn't connect to the server...");
  let s: &TcpStream = stream.get_ref();
};

pub fn get_welcome_msg(&self) -> Option<&str>

Get welcome message from the server on connect.

pub async fn login(&mut self, user: &str, password: &str) -> Result<()>

Log in to the FTP server.

pub async fn cwd(&mut self, path: &str) -> Result<()>

Change the current directory to the path specified.

pub async fn cdup(&mut self) -> Result<()>

Move the current directory to the parent directory.

pub async fn pwd(&mut self) -> Result<String>

Gets the current directory

pub async fn noop(&mut self) -> Result<()>

This does nothing. This is usually just used to keep the connection open.

pub async fn mkdir(&mut self, pathname: &str) -> Result<()>

This creates a new directory on the server.

pub async fn transfer_type(&mut self, file_type: FileType) -> Result<()>

Sets the type of file to be transferred. That is the implementation of TYPE command.

pub async fn quit(&mut self) -> Result<()>

Quits the current FTP session.

pub async fn restart_from(&mut self, offset: u64) -> Result<()>

Sets the byte from which the transfer is to be restarted.

pub async fn get(&mut self, file_name: &str) -> Result<BufReader<DataStream>>

Retrieves the file name specified from the server. This method is a more complicated way to retrieve a file. The reader returned should be dropped. Also you will have to read the response to make sure it has the correct value.

pub async fn rename(&mut self, from_name: &str, to_name: &str) -> Result<()>

Renames the file from_name to to_name

pub async fn retr<F, T, P, E>( &mut self, filename: &str, reader: F, ) -> Result<T, E>

where F: Fn(BufReader<DataStream>) -> P, P: Future<Output = Result<T, E>>, E: From<FtpError>,

The implementation of RETR command where filename is the name of the file to download from FTP and reader is the function which operates with the data stream opened.

use async_ftp::{FtpStream, DataStream, FtpError};
use tokio::io::{AsyncReadExt, BufReader};
use std::io::Cursor;
async {
  let mut conn = FtpStream::connect("172.25.82.139:21").await.unwrap();
  conn.login("Doe", "mumble").await.unwrap();
  let mut reader = Cursor::new("hello, world!".as_bytes());
  conn.put("retr.txt", &mut reader).await.unwrap();

  async fn lambda(mut reader: BufReader<DataStream>) -> Result<Vec<u8>, FtpError> {
    let mut buffer = Vec::new();
    reader
        .read_to_end(&mut buffer)
        .await
        .map_err(FtpError::ConnectionError)?;
    assert_eq!(buffer, "hello, world!".as_bytes());
    Ok(buffer)
  };

  assert!(conn.retr("retr.txt", lambda).await.is_ok());
  assert!(conn.rm("retr.txt").await.is_ok());
};

pub async fn simple_retr(&mut self, file_name: &str) -> Result<Cursor<Vec<u8>>>

Simple way to retr a file from the server. This stores the file in memory.

use async_ftp::{FtpStream, FtpError};
use std::io::Cursor;
async {
    let mut conn = FtpStream::connect("172.25.82.139:21").await?;
    conn.login("Doe", "mumble").await?;
    let mut reader = Cursor::new("hello, world!".as_bytes());
    conn.put("simple_retr.txt", &mut reader).await?;

    let cursor = conn.simple_retr("simple_retr.txt").await?;

    assert_eq!(cursor.into_inner(), "hello, world!".as_bytes());
    assert!(conn.rm("simple_retr.txt").await.is_ok());

    Ok::<(), FtpError>(())
};

pub async fn rmdir(&mut self, pathname: &str) -> Result<()>

Removes the remote pathname from the server.

pub async fn rm(&mut self, filename: &str) -> Result<()>

Remove the remote file from the server.

pub async fn put<R: AsyncRead + Unpin>( &mut self, filename: &str, r: &mut R, ) -> Result<()>

This stores a file on the server.

pub async fn list(&mut self, pathname: Option<&str>) -> Result<Vec<String>>

Execute LIST command which returns the detailed file listing in human readable format. If pathname is omited then the list of files in the current directory will be returned otherwise it will the list of files on pathname.

pub async fn nlst(&mut self, pathname: Option<&str>) -> Result<Vec<String>>

Execute NLST command which returns the list of file names only. If pathname is omited then the list of files in the current directory will be returned otherwise it will the list of files on pathname.

pub async fn mdtm(&mut self, pathname: &str) -> Result<Option<DateTime<Utc>>>

Retrieves the modification time of the file at pathname if it exists. In case the file does not exist None is returned.

pub async fn size(&mut self, pathname: &str) -> Result<Option<usize>>

Retrieves the size of the file in bytes at pathname if it exists. In case the file does not exist None is returned.

pub async fn read_response(&mut self, expected_code: u32) -> Result<Line>

pub async fn read_response_in(&mut self, expected_code: &[u32]) -> Result<Line>

Retrieve single line response