ftpasta

Types

Config

Configuration struct for building FTP connections.

pub type Config {
  Config(
    host: String,
    port: Int,
    tls: tls_config.TLSConfig,
    verify: Bool,
    username: String,
    password: String,
  )
}

Constructors

Config(
  host: String,
  port: Int,
  tls: tls_config.TLSConfig,
  verify: Bool,
  username: String,
  password: String,
)

Connection

opaque </>

Type representing an FTP connection.

pub opaque type Connection

Listing

</>

Remote file type.

pub type Listing {
  Directory(name: String)
  File(name: String, size: Int)
  Link(name: String, target: String)
}

Constructors

```
Directory(name: String)
```
```
File(name: String, size: Int)
```
```
Link(name: String, target: String)
```

Values

append_bytes

</>

pub fn append_bytes(
  connection: Connection,
  data: BitArray,
  remote_file: String,
) -> Result(Nil, ftp_error.FTPError)

Append some data onto a file on the server.

append_file

</>

pub fn append_file(
  connection: Connection,
  local_file: String,
  remote_file: String,
) -> Result(Nil, ftp_error.FTPError)

Append a file to another file on the server.

auth

</>

pub fn auth(
  config: Config,
  username: String,
  password: String,
) -> Config

Provide a username and password.

change_working_dir

</>

pub fn change_working_dir(
  connection: Connection,
  remote_dir: String,
) -> Result(Nil, ftp_error.FTPError)

Change directories on the remote server.

close

</>

pub fn close(connection: Connection) -> Nil

Close the connection.

connect

</>

pub fn connect(
  config: Config,
) -> Result(Connection, ftp_error.FTPError)

Connect to the server.

create_dir

</>

pub fn create_dir(
  connection: Connection,
  remote_dir: String,
) -> Result(Nil, ftp_error.FTPError)

Create a new directory on the server.

delete_dir

</>

pub fn delete_dir(
  connection: Connection,
  remote_dir: String,
) -> Result(Nil, ftp_error.FTPError)

Remove an empty directory from the server.

delete_file

</>

pub fn delete_file(
  connection: Connection,
  remote_file: String,
) -> Result(Nil, ftp_error.FTPError)

Remove a file from the server.

delete_recursive

</>

pub fn delete_recursive(
  connection: Connection,
  remote_dir: String,
) -> Result(Nil, ftp_error.FTPError)

Remove a directory and all contents from the server.

describe_error

</>

pub fn describe_error(error: ftp_error.FTPError) -> String

Convert an FTPError into a descriptive string.

download_bytes

</>

pub fn download_bytes(
  connection: Connection,
  remote_file: String,
) -> Result(BitArray, ftp_error.FTPError)

Fetch a file from the server, and return it as a BitArray.

download_file

</>

pub fn download_file(
  connection: Connection,
  remote_file: String,
  local_file: String,
) -> Result(Nil, ftp_error.FTPError)

Fetch a file from the server.

download_recursive

</>

pub fn download_recursive(
  connection: Connection,
  remote_dir: String,
  local_dir: String,
) -> Result(Nil, ftp_error.FTPError)

Fetch a directory and all contents recursively from the server.

encryption

</>

pub fn encryption(
  config: Config,
  tls: tls_config.TLSConfig,
) -> Config

Use encryption.

get_working_dir

</>

pub fn get_working_dir(
  connection: Connection,
) -> Result(String, ftp_error.FTPError)

Get the current remote path used for the connection.

list

</>

pub fn list(
  connection: Connection,
  remote_dir: String,
) -> Result(List(Listing), ftp_error.FTPError)

List all files, symlinks, and subdirectories in a directory.

new

</>

pub fn new(host: String) -> Config

Start building an FTP connection.

port

</>

pub fn port(config: Config, port: Int) -> Config

Use a non-default port.

rename

</>

pub fn rename(
  connection: Connection,
  old_path: String,
  new_path: String,
) -> Result(Nil, ftp_error.FTPError)

Rename a file or directory on the server.

upload_bytes

</>

pub fn upload_bytes(
  connection: Connection,
  data: BitArray,
  remote_file: String,
) -> Result(Nil, ftp_error.FTPError)

Send a data in memory to the server.

upload_file

</>

pub fn upload_file(
  connection: Connection,
  local_file: String,
  remote_file: String,
) -> Result(Nil, ftp_error.FTPError)

Send a file to the server.

upload_recursive

</>

pub fn upload_recursive(
  connection: Connection,
  local_dir: String,
  remote_dir: String,
) -> Result(Nil, ftp_error.FTPError)

Send a directory and all contents to the server.

verification

</>

pub fn verification(config: Config, enabled: Bool) -> Config

How to verify certificates.