SFTP Client

v1.0.0

SFTP Client v1.0.0 SFTPClient View Source

Link to this section Summary

Types

access_mode()

File access modes that can be used when opening files directly from the remote server.

Functions

close_handle(handle)

See SFTPClient.Operations.CloseHandle.close_handle/1.

close_handle!(handle)

See SFTPClient.Operations.CloseHandle.close_handle!/1.

connect(config_or_opts)

See SFTPClient.Operations.Connect.connect/1.

connect!(config_or_opts)

See SFTPClient.Operations.Connect.connect!/1.

delete_dir(conn, path)

See SFTPClient.Operations.DeleteDir.delete_dir/2.

delete_dir!(conn, path)

See SFTPClient.Operations.DeleteDir.delete_dir!/2.

delete_file(conn, path)

See SFTPClient.Operations.DeleteFile.delete_file/2.

delete_file!(conn, path)

See SFTPClient.Operations.DeleteFile.delete_file!/2.

disconnect(conn)

See SFTPClient.Operations.Disconnect.disconnect/1.

download_file(conn, remote_path, local_path)

See SFTPClient.Operations.DownloadFile.download_file/3.

download_file!(conn, remote_path, local_path)

See SFTPClient.Operations.DownloadFile.download_file!/3.

file_info(conn, path)

See SFTPClient.Operations.FileInfo.file_info/2.

file_info!(conn, path)

See SFTPClient.Operations.FileInfo.file_info!/2.

link_info(conn, path)

See SFTPClient.Operations.LinkInfo.link_info/2.

link_info!(conn, path)

See SFTPClient.Operations.LinkInfo.link_info!/2.

list_dir(conn, path)

See SFTPClient.Operations.ListDir.list_dir/2.

list_dir!(conn, path)

See SFTPClient.Operations.ListDir.list_dir!/2.

make_dir(conn, path)

See SFTPClient.Operations.MakeDir.make_dir/2.

make_dir!(conn, path)

See SFTPClient.Operations.MakeDir.make_dir!/2.

make_symlink(conn, symlink_path, target_path)

See SFTPClient.Operations.MakeSymlink.make_symlink/3.

make_symlink!(conn, symlink_path, target_path)

See SFTPClient.Operations.MakeSymlink.make_symlink!/3.

open_dir(conn, path)

See SFTPClient.Operations.OpenDir.open_dir/2.

open_dir!(conn, path)

See SFTPClient.Operations.OpenDir.open_dir!/2.

open_file(conn, path, modes)

See SFTPClient.Operations.OpenFile.open_file/3.

open_file!(conn, path, modes)

See SFTPClient.Operations.OpenFile.open_file!/3.

read_file(conn, path)

See SFTPClient.Operations.ReadFile.read_file/2.

read_file!(conn, path)

See SFTPClient.Operations.ReadFile.read_file!/2.

read_file_chunk(handle, length)

See SFTPClient.Operations.ReadFileChunk.read_file_chunk/2.

read_file_chunk!(handle, length)

See SFTPClient.Operations.ReadFileChunk.read_file_chunk!/2.

read_link(conn, path)

See SFTPClient.Operations.ReadLink.read_link/2.

read_link!(conn, path)

See SFTPClient.Operations.ReadLink.read_link!/2.

rename(conn, old_name, new_name)

See SFTPClient.Operations.Rename.rename/3.

rename!(conn, old_name, new_name)

See SFTPClient.Operations.Rename.rename!/3.

stream_file(conn, path)

See SFTPClient.Operations.StreamFile.stream_file/2.

stream_file(conn, path, chunk_size)

See SFTPClient.Operations.StreamFile.stream_file/3.

stream_file!(conn, path)

See SFTPClient.Operations.StreamFile.stream_file!/2.

stream_file!(conn, path, chunk_size)

See SFTPClient.Operations.StreamFile.stream_file!/3.

write_file(conn, path, data)

See SFTPClient.Operations.WriteFile.write_file/3.

write_file!(conn, path, data)

See SFTPClient.Operations.WriteFile.write_file!/3.

write_file_chunk(handle, data)

See SFTPClient.Operations.WriteFileChunk.write_file_chunk/2.

write_file_chunk!(handle, data)

See SFTPClient.Operations.WriteFileChunk.write_file_chunk!/2.

Link to this section Types

Link to this type

access_mode() View Source 
access_mode() :: :read | :write | :creat | :trunc | :append | :binary

File access modes that can be used when opening files directly from the remote server.

Link to this section Functions

Link to this function

close_handle(handle) View Source

See SFTPClient.Operations.CloseHandle.close_handle/1.

Link to this function

close_handle!(handle) View Source

See SFTPClient.Operations.CloseHandle.close_handle!/1.

Link to this function

connect(config_or_opts) View Source

See SFTPClient.Operations.Connect.connect/1.

Link to this function

connect!(config_or_opts) View Source

See SFTPClient.Operations.Connect.connect!/1.

Link to this function

delete_dir(conn, path) View Source

See SFTPClient.Operations.DeleteDir.delete_dir/2.

Link to this function

delete_dir!(conn, path) View Source

See SFTPClient.Operations.DeleteDir.delete_dir!/2.

Link to this function

delete_file(conn, path) View Source

See SFTPClient.Operations.DeleteFile.delete_file/2.

Link to this function

delete_file!(conn, path) View Source

See SFTPClient.Operations.DeleteFile.delete_file!/2.

Link to this function

disconnect(conn) View Source

See SFTPClient.Operations.Disconnect.disconnect/1.

Link to this function

download_file(conn, remote_path, local_path) View Source

See SFTPClient.Operations.DownloadFile.download_file/3.

Link to this function

download_file!(conn, remote_path, local_path) View Source

See SFTPClient.Operations.DownloadFile.download_file!/3.

Link to this function

file_info(conn, path) View Source

See SFTPClient.Operations.FileInfo.file_info/2.

Link to this function

file_info!(conn, path) View Source

See SFTPClient.Operations.FileInfo.file_info!/2.

Link to this function

list_dir(conn, path) View Source

See SFTPClient.Operations.ListDir.list_dir/2.

Link to this function

list_dir!(conn, path) View Source

See SFTPClient.Operations.ListDir.list_dir!/2.

Link to this function

make_dir(conn, path) View Source

See SFTPClient.Operations.MakeDir.make_dir/2.

Link to this function

make_dir!(conn, path) View Source

See SFTPClient.Operations.MakeDir.make_dir!/2.

Link to this function

make_symlink(conn, symlink_path, target_path) View Source

See SFTPClient.Operations.MakeSymlink.make_symlink/3.

Link to this function

make_symlink!(conn, symlink_path, target_path) View Source

See SFTPClient.Operations.MakeSymlink.make_symlink!/3.

Link to this function

open_dir(conn, path) View Source

See SFTPClient.Operations.OpenDir.open_dir/2.

Link to this function

open_dir!(conn, path) View Source

See SFTPClient.Operations.OpenDir.open_dir!/2.

Link to this function

open_file(conn, path, modes) View Source

See SFTPClient.Operations.OpenFile.open_file/3.

Link to this function

open_file!(conn, path, modes) View Source

See SFTPClient.Operations.OpenFile.open_file!/3.

Link to this function

read_file(conn, path) View Source

See SFTPClient.Operations.ReadFile.read_file/2.

Link to this function

read_file!(conn, path) View Source

See SFTPClient.Operations.ReadFile.read_file!/2.

Link to this function

read_file_chunk(handle, length) View Source

See SFTPClient.Operations.ReadFileChunk.read_file_chunk/2.

Link to this function

read_file_chunk!(handle, length) View Source

See SFTPClient.Operations.ReadFileChunk.read_file_chunk!/2.

Link to this function

read_link(conn, path) View Source

See SFTPClient.Operations.ReadLink.read_link/2.

Link to this function

read_link!(conn, path) View Source

See SFTPClient.Operations.ReadLink.read_link!/2.

Link to this function

rename(conn, old_name, new_name) View Source

See SFTPClient.Operations.Rename.rename/3.

Link to this function

rename!(conn, old_name, new_name) View Source

See SFTPClient.Operations.Rename.rename!/3.

Link to this function

stream_file(conn, path) View Source

See SFTPClient.Operations.StreamFile.stream_file/2.

Link to this function

stream_file(conn, path, chunk_size) View Source

See SFTPClient.Operations.StreamFile.stream_file/3.

Link to this function

stream_file!(conn, path) View Source

See SFTPClient.Operations.StreamFile.stream_file!/2.

Link to this function

stream_file!(conn, path, chunk_size) View Source

See SFTPClient.Operations.StreamFile.stream_file!/3.

Link to this function

write_file(conn, path, data) View Source

See SFTPClient.Operations.WriteFile.write_file/3.

Link to this function

write_file!(conn, path, data) View Source

See SFTPClient.Operations.WriteFile.write_file!/3.

Link to this function

write_file_chunk(handle, data) View Source

See SFTPClient.Operations.WriteFileChunk.write_file_chunk/2.

Link to this function

write_file_chunk!(handle, data) View Source

See SFTPClient.Operations.WriteFileChunk.write_file_chunk!/2.