/usr/share/doc/nim-doc/html/asyncftpclient.html

<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<!--  This file is generated by Nim. -->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />

<!-- Favicon -->
<link rel="shortcut icon" href="data:image/x-icon;base64,AAABAAEAEBAAAAEAIABoBAAAFgAAACgAAAAQAAAAIAAAAAEAIAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AAAAAAUAAAAF////AP///wD///8A////AP///wD///8A////AP///wD///8A////AAAAAAIAAABbAAAAlQAAAKIAAACbAAAAmwAAAKIAAACVAAAAWwAAAAL///8A////AP///wD///8A////AAAAABQAAADAAAAAYwAAAA3///8A////AP///wD///8AAAAADQAAAGMAAADAAAAAFP///wD///8A////AP///wAAAACdAAAAOv///wD///8A////AP///wD///8A////AP///wD///8AAAAAOgAAAJ3///8A////AP///wAAAAAnAAAAcP///wAAAAAoAAAASv///wD///8A////AP///wAAAABKAAAAKP///wAAAABwAAAAJ////wD///8AAAAAgQAAABwAAACIAAAAkAAAAJMAAACtAAAAFQAAABUAAACtAAAAkwAAAJAAAACIAAAAHAAAAIH///8A////AAAAAKQAAACrAAAAaP///wD///8AAAAARQAAANIAAADSAAAARf///wD///8AAAAAaAAAAKsAAACk////AAAAADMAAACcAAAAnQAAABj///8A////AP///wAAAAAYAAAAGP///wD///8A////AAAAABgAAACdAAAAnAAAADMAAAB1AAAAwwAAAP8AAADpAAAAsQAAAE4AAAAb////AP///wAAAAAbAAAATgAAALEAAADpAAAA/wAAAMMAAAB1AAAAtwAAAOkAAAD/AAAA/wAAAP8AAADvAAAA3gAAAN4AAADeAAAA3gAAAO8AAAD/AAAA/wAAAP8AAADpAAAAtwAAAGUAAAA/AAAA3wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAADfAAAAPwAAAGX///8A////AAAAAEgAAADtAAAAvwAAAL0AAADGAAAA7wAAAO8AAADGAAAAvQAAAL8AAADtAAAASP///wD///8A////AP///wD///8AAAAAO////wD///8A////AAAAAIcAAACH////AP///wD///8AAAAAO////wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A//8AAP//AAD4HwAA7/cAAN/7AAD//wAAoYUAAJ55AACf+QAAh+EAAAAAAADAAwAA4AcAAP5/AAD//wAA//8AAA=="/>

<!-- Google fonts -->
<link href='http://fonts.googleapis.com/css?family=Raleway:400,600,900' rel='stylesheet' type='text/css'/>
<link href='http://fonts.googleapis.com/css?family=Source+Code+Pro:400,500,600' rel='stylesheet' type='text/css'/>

<!-- CSS -->
<title>Module asyncftpclient</title>
<style type="text/css" >
/*
Stylesheet for use with Docutils/rst2html.

See http://docutils.sf.net/docs/howto/html-stylesheets.html for how to
customize this style sheet.

Modified from Chad Skeeters' rst2html-style
https://bitbucket.org/cskeeters/rst2html-style/

Modified by Boyd Greenfield
*/
/* SCSS variables */
/* Text weights */
/* Body colors */
/* Text colors */
/* Link colors */
/* Syntax highlighting colors */
/* Pct changes */
/* Mixins */
/* Body/layout */
html {
  font-size: 100%;
  -webkit-text-size-adjust: 100%;
  -ms-text-size-adjust: 100%; }

/* Where we want fancier font if available */
h1, h2, h3, h4, h5, h6, p.module-desc, table.docinfo + blockquote p, table.docinfo blockquote p, h1 + blockquote p {
  font-family: "Raleway", "Helvetica Neue", "HelveticaNeue", Helvetica, Arial, sans-serif !important; }

h1.title {
  font-weight: 900; }

body {
  font-family: "Helvetica Neue", "HelveticaNeue", "Raleway", Helvetica, Arial, sans-serif;
  font-weight: 400;
  font-size: 14px;
  line-height: 20px;
  color: #666;
  background-color: rgba(252, 248, 244, 0.75); }

/* Skeleton grid */
.container {
  position: relative;
  width: 100%;
  max-width: 960px;
  margin: 0 auto;
  padding: 0 20px;
  box-sizing: border-box; }

.column,
.columns {
  width: 100%;
  float: left;
  box-sizing: border-box; }

/* For devices larger than 400px */
@media (min-width: 400px) {
  .container {
    width: 100%;
    padding: 0; } }
/* For devices larger than 650px */
@media (min-width: 650px) {
  .container {
    width: 100%; }

  .column,
  .columns {
    margin-left: 4%; }

  .column:first-child,
  .columns:first-child {
    margin-left: 0; }

  .one.column,
  .one.columns {
    width: 4.66666666667%; }

  .two.columns {
    width: 13.3333333333%; }

  .three.columns {
    width: 22%; }

  .four.columns {
    width: 30.6666666667%; }

  .five.columns {
    width: 39.3333333333%; }

  .six.columns {
    width: 48%; }

  .seven.columns {
    width: 56.6666666667%; }

  .eight.columns {
    width: 65.3333333333%; }

  .nine.columns {
    width: 74.0%; }

  .ten.columns {
    width: 82.6666666667%; }

  .eleven.columns {
    width: 91.3333333333%; }

  .twelve.columns {
    width: 100%;
    margin-left: 0; }

  .one-third.column {
    width: 30.6666666667%; }

  .two-thirds.column {
    width: 65.3333333333%; } }
/* Customer Overrides */
.footer {
  text-align: center;
  color: #969696;
  padding-top: 10%; }

p.module-desc {
  font-size: 1.1em;
  color: #666666; }

a.link-seesrc {
  color: #aec7d2;
  font-style: italic; }

a.link-seesrc:hover {
  color: #6c9aae; }

#toc-list {
  word-wrap: break-word; }

ul.simple-toc {
  list-style: none; }

ul.simple-toc a.reference-toplevel {
  font-weight: bold;
  color: #0077b3; }

ul.simple-toc-section {
  list-style-type: circle;
  color: #6c9aae; }

ul.simple-toc-section a.reference {
  color: #0077b3; }

cite {
  font-style: italic !important; }

dt > pre {
  border-color: rgba(0, 0, 0, 0.15);
  background-color: transparent;
  margin: 15px 0px 5px; }

dd > pre {
  border-color: rgba(0, 0, 0, 0.1);
  background-color: whitesmoke;
  margin-top: 8px; }

.item > dd {
  margin-left: 10px;
  margin-bottom: 30px; }

/* Nim line-numbered tables */
.line-nums-table {
  width: 100%;
  table-layout: fixed; }

table.line-nums-table {
  border-radius: 4px;
  border: 1px solid #cccccc;
  background-color: whitesmoke;
  border-collapse: separate;
  margin-top: 15px;
  margin-bottom: 25px; }

.line-nums-table tbody {
  border: none; }

.line-nums-table td pre {
  border: none;
  background-color: transparent; }

.line-nums-table td.blob-line-nums {
  width: 28px; }

.line-nums-table td.blob-line-nums pre {
  color: #b0b0b0;
  -webkit-filter: opacity(75%);
  text-align: right;
  border-color: transparent;
  background-color: transparent;
  padding-left: 0px;
  margin-left: 0px;
  padding-right: 0px;
  margin-right: 0px; }

/* Docgen styles */
/* Links */
a {
  color: #0077b3;
  text-decoration: none; }

a:hover,
a:focus {
  color: #00334d;
  text-decoration: underline; }

a:visited {
  color: #00334d; }

a:focus {
  outline: thin dotted #2d2d2d;
  outline: 5px auto -webkit-focus-ring-color;
  outline-offset: -2px; }

a:hover,
a:active {
  outline: 0; }

sub,
sup {
  position: relative;
  font-size: 75%;
  line-height: 0;
  vertical-align: baseline; }

sup {
  top: -0.5em; }

sub {
  bottom: -0.25em; }

img {
  width: auto;
  height: auto;
  max-width: 100%;
  vertical-align: middle;
  border: 0;
  -ms-interpolation-mode: bicubic; }

@media print {
  * {
    color: black !important;
    text-shadow: none !important;
    background: transparent !important;
    box-shadow: none !important; }

  a,
  a:visited {
    text-decoration: underline; }

  a[href]:after {
    content: " (" attr(href) ")"; }

  abbr[title]:after {
    content: " (" attr(title) ")"; }

  .ir a:after,
  a[href^="javascript:"]:after,
  a[href^="#"]:after {
    content: ""; }

  pre,
  blockquote {
    border: 1px solid #999;
    page-break-inside: avoid; }

  thead {
    display: table-header-group; }

  tr,
  img {
    page-break-inside: avoid; }

  img {
    max-width: 100% !important; }

  @page {
    margin: 0.5cm; }

  h1 {
    page-break-before: always; }

  h1.title {
    page-break-before: avoid; }

  p,
  h2,
  h3 {
    orphans: 3;
    widows: 3; }

  h2,
  h3 {
    page-break-after: avoid; } }
.img-rounded {
  -webkit-border-radius: 6px;
  -moz-border-radius: 6px;
  border-radius: 6px; }

.img-polaroid {
  padding: 4px;
  background-color: rgba(252, 248, 244, 0.75);
  border: 1px solid #ccc;
  border: 1px solid rgba(0, 0, 0, 0.2);
  -webkit-box-shadow: 0 1px 3px rgba(0, 0, 0, 0.1);
  -moz-box-shadow: 0 1px 3px rgba(0, 0, 0, 0.1);
  box-shadow: 0 1px 3px rgba(0, 0, 0, 0.1); }

p {
  margin: 0 0 12px; }

small {
  font-size: 85%; }

strong {
  font-weight: 600; }

em {
  font-style: italic; }

cite {
  font-style: normal; }

h1,
h2,
h3,
h4,
h5,
h6 {
  font-family: "Helvetica Neue", "HelveticaNeue", "Raleway", Helvetica, Arial, sans-serif;
  font-weight: 600;
  line-height: 20px;
  color: inherit;
  text-rendering: optimizelegibility; }

h1 {
  font-size: 2em;
  padding-bottom: .15em;
  border-bottom: 1px solid #aaaaaa;
  margin-top: 1.0em;
  line-height: 1.2em; }

h1.title {
  padding-bottom: 1em;
  border-bottom: 0px;
  font-size: 2.75em; }

h2 {
  font-size: 1.5em;
  margin-top: 1.5em; }

h3 {
  font-size: 1.3em;
  font-style: italic;
  margin-top: 0.75em; }

h4 {
  font-size: 1.3em;
  margin-top: 0.5em; }

h5 {
  font-size: 1.2em;
  margin-top: 0.25em; }

h6 {
  font-size: 1.1em; }

ul,
ol {
  padding: 0;
  margin: 0 0 0px 15px; }

ul ul,
ul ol,
ol ol,
ol ul {
  margin-bottom: 0; }

li {
  line-height: 20px; }

dl {
  margin-bottom: 20px; }

dt,
dd {
  line-height: 20px; }

dt {
  font-weight: bold; }

dd {
  margin-left: 10px;
  margin-bottom: 26px; }

hr {
  margin: 20px 0;
  border: 0;
  border-top: 1px solid #eeeeee;
  border-bottom: 1px solid #ffffff; }

abbr[title],
abbr[data-original-title] {
  cursor: help;
  border-bottom: 1px dotted #999999; }

abbr.initialism {
  font-size: 90%;
  text-transform: uppercase; }

blockquote {
  padding: 0 0 0 15px;
  margin: 0 0 20px;
  border-left: 5px solid #EFEBE0; }

table.docinfo + blockquote, table.docinfo blockquote, h1 + blockquote {
  border-left: 5px solid #c9c9c9;
}

table.docinfo + blockquote p, table.docinfo blockquote p, h1 + blockquote p {
  margin-bottom: 0;
  font-size: 15px;
  font-weight: 200;
  line-height: 1.5;
  font-style: italic; }

q:before,
q:after,
blockquote:before,
blockquote:after {
  content: ""; }

address {
  display: block;
  margin-bottom: 20px;
  font-style: normal;
  line-height: 20px; }

code,
pre {
  font-family: "Source Code Pro", Monaco, Menlo, Consolas, "Courier New", monospace;
  padding: 0 3px 2px;
  font-weight: 500;
  font-size: 12px;
  color: #444444;
  -webkit-border-radius: 3px;
  -moz-border-radius: 3px;
  border-radius: 3px; }

.pre {
  font-family: "Source Code Pro", Monaco, Menlo, Consolas, "Courier New", monospace;
  font-weight: 600;
  /*color: #504da6;*/
}

code {
  padding: 2px 4px;
  color: #444444;
  white-space: nowrap;
  background-color: white;
  border: 1px solid #777777; }

pre {
  display: inline-block;
  box-sizing: border-box;
  min-width: calc(100% - 19.5px);
  padding: 9.5px;
  margin: 0.25em 10px 0.25em 10px;
  font-size: 14px;
  line-height: 20px;
  white-space: pre !important;
  overflow-y: hidden;
  overflow-x: visible;
  background-color: whitesmoke;
  border: 1px solid #cccccc;
  -webkit-border-radius: 4px;
  -moz-border-radius: 4px;
  border-radius: 4px; }

pre.prettyprint {
  margin-bottom: 20px; }

pre code {
  padding: 0;
  color: inherit;
  white-space: pre;
  overflow-x: visible;
  background-color: transparent;
  border: 0; }

.pre-scrollable {
  max-height: 340px;
  overflow-y: scroll; }

table {
  max-width: 100%;
  background-color: transparent;
  border-collapse: collapse;
  border-spacing: 0; }

table th, table td {
  padding: 0px 8px 0px;
}

.table {
  width: 100%;
  margin-bottom: 20px; }

.table th,
.table td {
  padding: 8px;
  line-height: 20px;
  text-align: left;
  vertical-align: top;
  border-top: 1px solid #444444; }

.table th {
  font-weight: bold; }

.table thead th {
  vertical-align: bottom; }

.table caption + thead tr:first-child th,
.table caption + thead tr:first-child td,
.table colgroup + thead tr:first-child th,
.table colgroup + thead tr:first-child td,
.table thead:first-child tr:first-child th,
.table thead:first-child tr:first-child td {
  border-top: 0; }

.table tbody + tbody {
  border-top: 2px solid #444444; }

.table .table {
  background-color: rgba(252, 248, 244, 0.75); }

.table-condensed th,
.table-condensed td {
  padding: 4px 5px; }

.table-bordered {
  border: 1px solid #444444;
  border-collapse: separate;
  *border-collapse: collapse;
  border-left: 0;
  -webkit-border-radius: 4px;
  -moz-border-radius: 4px;
  border-radius: 4px; }

.table-bordered th,
.table-bordered td {
  border-left: 1px solid #444444; }

.table-bordered caption + thead tr:first-child th,
.table-bordered caption + tbody tr:first-child th,
.table-bordered caption + tbody tr:first-child td,
.table-bordered colgroup + thead tr:first-child th,
.table-bordered colgroup + tbody tr:first-child th,
.table-bordered colgroup + tbody tr:first-child td,
.table-bordered thead:first-child tr:first-child th,
.table-bordered tbody:first-child tr:first-child th,
.table-bordered tbody:first-child tr:first-child td {
  border-top: 0; }

.table-bordered thead:first-child tr:first-child > th:first-child,
.table-bordered tbody:first-child tr:first-child > td:first-child,
.table-bordered tbody:first-child tr:first-child > th:first-child {
  -webkit-border-top-left-radius: 4px;
  border-top-left-radius: 4px;
  -moz-border-radius-topleft: 4px; }

.table-bordered thead:first-child tr:first-child > th:last-child,
.table-bordered tbody:first-child tr:first-child > td:last-child,
.table-bordered tbody:first-child tr:first-child > th:last-child {
  -webkit-border-top-right-radius: 4px;
  border-top-right-radius: 4px;
  -moz-border-radius-topright: 4px; }

.table-bordered thead:last-child tr:last-child > th:first-child,
.table-bordered tbody:last-child tr:last-child > td:first-child,
.table-bordered tbody:last-child tr:last-child > th:first-child,
.table-bordered tfoot:last-child tr:last-child > td:first-child,
.table-bordered tfoot:last-child tr:last-child > th:first-child {
  -webkit-border-bottom-left-radius: 4px;
  border-bottom-left-radius: 4px;
  -moz-border-radius-bottomleft: 4px; }

.table-bordered thead:last-child tr:last-child > th:last-child,
.table-bordered tbody:last-child tr:last-child > td:last-child,
.table-bordered tbody:last-child tr:last-child > th:last-child,
.table-bordered tfoot:last-child tr:last-child > td:last-child,
.table-bordered tfoot:last-child tr:last-child > th:last-child {
  -webkit-border-bottom-right-radius: 4px;
  border-bottom-right-radius: 4px;
  -moz-border-radius-bottomright: 4px; }

.table-bordered tfoot + tbody:last-child tr:last-child td:first-child {
  -webkit-border-bottom-left-radius: 0;
  border-bottom-left-radius: 0;
  -moz-border-radius-bottomleft: 0; }

.table-bordered tfoot + tbody:last-child tr:last-child td:last-child {
  -webkit-border-bottom-right-radius: 0;
  border-bottom-right-radius: 0;
  -moz-border-radius-bottomright: 0; }

.table-bordered caption + thead tr:first-child th:first-child,
.table-bordered caption + tbody tr:first-child td:first-child,
.table-bordered colgroup + thead tr:first-child th:first-child,
.table-bordered colgroup + tbody tr:first-child td:first-child {
  -webkit-border-top-left-radius: 4px;
  border-top-left-radius: 4px;
  -moz-border-radius-topleft: 4px; }

.table-bordered caption + thead tr:first-child th:last-child,
.table-bordered caption + tbody tr:first-child td:last-child,
.table-bordered colgroup + thead tr:first-child th:last-child,
.table-bordered colgroup + tbody tr:first-child td:last-child {
  -webkit-border-top-right-radius: 4px;
  border-top-right-radius: 4px;
  -moz-border-radius-topright: 4px; }

table.docutils th {
  background-color: #e8e8e8; }

table.docutils tr:hover {
  background-color: whitesmoke; }

.table-striped tbody > tr:nth-child(odd) > td,
.table-striped tbody > tr:nth-child(odd) > th {
  background-color: rgba(252, 248, 244, 0.75); }

.table-hover tbody tr:hover > td,
.table-hover tbody tr:hover > th {
  background-color: rgba(241, 222, 204, 0.75); }

table td[class*="span"],
table th[class*="span"],
.row-fluid table td[class*="span"],
.row-fluid table th[class*="span"] {
  display: table-cell;
  float: none;
  margin-left: 0; }

.hero-unit {
  padding: 60px;
  margin-bottom: 30px;
  font-size: 18px;
  font-weight: 200;
  line-height: 30px;
  color: inherit;
  background-color: rgba(230, 197, 164, 0.75);
  -webkit-border-radius: 6px;
  -moz-border-radius: 6px;
  border-radius: 6px; }

.hero-unit h1 {
  margin-bottom: 0;
  font-size: 60px;
  line-height: 1;
  letter-spacing: -1px;
  color: inherit; }

.hero-unit li {
  line-height: 30px; }

/* rst2html default used to remove borders from tables and images */
.borderless, table.borderless td, table.borderless th {
  border: 0; }

table.borderless td, table.borderless th {
  /* Override padding for "table.docutils td" with "! important".
     The right padding separates the table cells. */
  padding: 0 0.5em 0 0 !important; }

.first {
  /* Override more specific margin styles with "! important". */
  margin-top: 0 !important; }

.last, .with-subtitle {
  margin-bottom: 0 !important; }

.hidden {
  display: none; }

a.toc-backref {
  text-decoration: none;
  color: #444444; }

blockquote.epigraph {
  margin: 2em 5em; }

dl.docutils dd {
  margin-bottom: 0.5em; }

object[type="image/svg+xml"], object[type="application/x-shockwave-flash"] {
  overflow: hidden; }

/* Uncomment (and remove this text!) to get bold-faced definition list terms
dl.docutils dt {
  font-weight: bold }
*/
div.abstract {
  margin: 2em 5em; }

div.abstract p.topic-title {
  font-weight: bold;
  text-align: center; }

div.admonition, div.attention, div.caution, div.danger, div.error,
div.hint, div.important, div.note, div.tip, div.warning {
  margin: 2em;
  border: medium outset;
  padding: 1em; }

div.note, div.warning {
  margin: 1.5em 0px;
  border: none; }

div.note p.admonition-title,
div.warning p.admonition-title {
  display: none; }

/* Clearfix
 * http://css-tricks.com/snippets/css/clear-fix/
 */
div.note:after,
div.warning:after {
  content: "";
  display: table;
  clear: both; }

div.note p:before,
div.warning p:before {
  display: block;
  float: left;
  font-size: 4em;
  line-height: 1em;
  margin-right: 20px;
  margin-left: 0em;
  margin-top: -10px;
  content: '\0270D';
  /*handwriting*/ }

div.warning p:before {
  content: '\026A0';
  /*warning*/ }

div.admonition p.admonition-title, div.hint p.admonition-title,
div.important p.admonition-title, div.note p.admonition-title,
div.tip p.admonition-title {
  font-weight: bold;
  font-family: "Helvetica Neue", "HelveticaNeue", "Raleway", Helvetica, Arial, sans-serif; }

div.attention p.admonition-title, div.caution p.admonition-title,
div.danger p.admonition-title, div.error p.admonition-title,
div.warning p.admonition-title, .code .error {
  color: #b30000;
  font-weight: bold;
  font-family: "Helvetica Neue", "HelveticaNeue", "Raleway", Helvetica, Arial, sans-serif; }

/* Uncomment (and remove this text!) to get reduced vertical space in
   compound paragraphs.
div.compound .compound-first, div.compound .compound-middle {
  margin-bottom: 0.5em }

div.compound .compound-last, div.compound .compound-middle {
  margin-top: 0.5em }
*/
div.dedication {
  margin: 2em 5em;
  text-align: center;
  font-style: italic; }

div.dedication p.topic-title {
  font-weight: bold;
  font-style: normal; }

div.figure {
  margin-left: 2em;
  margin-right: 2em; }

div.footer, div.header {
  clear: both;
  font-size: smaller; }

div.line-block {
  display: block;
  margin-top: 1em;
  margin-bottom: 1em; }

div.line-block div.line-block {
  margin-top: 0;
  margin-bottom: 0;
  margin-left: 1.5em; }

div.sidebar {
  margin: 0 0 0.5em 1em;
  border: medium outset;
  padding: 1em;
  background-color: rgba(252, 248, 244, 0.75);
  width: 40%;
  float: right;
  clear: right; }

div.sidebar p.rubric {
  font-family: "Helvetica Neue", "HelveticaNeue", "Raleway", Helvetica, Arial, sans-serif;
  font-size: medium; }

div.system-messages {
  margin: 5em; }

div.system-messages h1 {
  color: #b30000; }

div.system-message {
  border: medium outset;
  padding: 1em; }

div.system-message p.system-message-title {
  color: #b30000;
  font-weight: bold; }

div.topic {
  margin: 2em; }

h1.section-subtitle, h2.section-subtitle, h3.section-subtitle,
h4.section-subtitle, h5.section-subtitle, h6.section-subtitle {
  margin-top: 0.4em; }

h1.title {
  text-align: center; }

h2.subtitle {
  text-align: center; }

hr.docutils {
  width: 75%; }

img.align-left, .figure.align-left, object.align-left {
  clear: left;
  float: left;
  margin-right: 1em; }

img.align-right, .figure.align-right, object.align-right {
  clear: right;
  float: right;
  margin-left: 1em; }

img.align-center, .figure.align-center, object.align-center {
  display: block;
  margin-left: auto;
  margin-right: auto; }

.align-left {
  text-align: left; }

.align-center {
  clear: both;
  text-align: center; }

.align-right {
  text-align: right; }

/* reset inner alignment in figures */
div.align-right {
  text-align: inherit; }

/* div.align-center * { */
/*   text-align: left } */

ul.simple > li {
  margin-bottom: 0.5em }

ol.simple, ul.simple {
  margin-bottom: 1em; }

ol.arabic {
  list-style: decimal; }

ol.loweralpha {
  list-style: lower-alpha; }

ol.upperalpha {
  list-style: upper-alpha; }

ol.lowerroman {
  list-style: lower-roman; }

ol.upperroman {
  list-style: upper-roman; }

p.attribution {
  text-align: right;
  margin-left: 50%; }

p.caption {
  font-style: italic; }

p.credits {
  font-style: italic;
  font-size: smaller; }

p.label {
  white-space: nowrap; }

p.rubric {
  font-weight: bold;
  font-size: larger;
  color: maroon;
  text-align: center; }

p.sidebar-title {
  font-family: "Helvetica Neue", "HelveticaNeue", "Raleway", Helvetica, Arial, sans-serif;
  font-weight: bold;
  font-size: larger; }

p.sidebar-subtitle {
  font-family: "Helvetica Neue", "HelveticaNeue", "Raleway", Helvetica, Arial, sans-serif;
  font-weight: bold; }

p.topic-title {
  font-weight: bold; }

pre.address {
  margin-bottom: 0;
  margin-top: 0;
  font: inherit; }

pre.literal-block, pre.doctest-block, pre.math, pre.code {
  margin-left: 2em;
  margin-right: 2em; }

pre.code .ln {
  color: grey; }

/* line numbers */
pre.code, code {
  background-color: #eeeeee; }

pre.code .comment, code .comment {
  color: #5c6576; }

pre.code .keyword, code .keyword {
  color: #3B0D06;
  font-weight: bold; }

pre.code .literal.string, code .literal.string {
  color: #0c5404; }

pre.code .name.builtin, code .name.builtin {
  color: #352b84; }

pre.code .deleted, code .deleted {
  background-color: #DEB0A1; }

pre.code .inserted, code .inserted {
  background-color: #A3D289; }

span.classifier {
  font-family: "Helvetica Neue", "HelveticaNeue", "Raleway", Helvetica, Arial, sans-serif;
  font-style: oblique; }

span.classifier-delimiter {
  font-family: "Helvetica Neue", "HelveticaNeue", "Raleway", Helvetica, Arial, sans-serif;
  font-weight: bold; }

span.interpreted {
  font-family: "Helvetica Neue", "HelveticaNeue", "Raleway", Helvetica, Arial, sans-serif; }

span.option {
  white-space: nowrap; }

span.pre {
  white-space: pre; }

span.problematic {
  color: #b30000; }

span.section-subtitle {
  /* font-size relative to parent (h1..h6 element) */
  font-size: 80%; }

table.citation {
  border-left: solid 1px #666666;
  margin-left: 1px; }

table.docinfo {
  margin: 0em;
  margin-top: 2em;
  margin-bottom: 2em;
  font-family: "Raleway", "Helvetica Neue", "HelveticaNeue", Helvetica, Arial, sans-serif !important;
  color: #444444; }

table.docutils {
  margin-top: 0.5em;
  margin-bottom: 0.5em; }

table.footnote {
  border-left: solid 1px #2d2d2d;
  margin-left: 1px; }

table.docutils td, table.docutils th,
table.docinfo td, table.docinfo th {
  padding-left: 0.5em;
  padding-right: 0.5em;
  vertical-align: top; }

table.docutils th.field-name, table.docinfo th.docinfo-name {
  font-weight: 700;
  text-align: left;
  white-space: nowrap;
  padding-left: 0; }

h1 tt.docutils, h2 tt.docutils, h3 tt.docutils,
h4 tt.docutils, h5 tt.docutils, h6 tt.docutils {
  font-size: 100%; }

ul.auto-toc {
  list-style-type: none; }

span.DecNumber {
  color: #252dbe; }

span.BinNumber {
  color: #252dbe; }

span.HexNumber {
  color: #252dbe; }

span.OctNumber {
  color: #252dbe; }

span.FloatNumber {
  color: #252dbe; }

span.Identifier {
  color: #3b3b3b; }

span.Keyword {
  font-weight: 600;
  color: #5e8f60; }

span.StringLit {
  color: #a4255b; }

span.LongStringLit {
  color: #a4255b; }

span.CharLit {
  color: #a4255b; }

span.EscapeSequence {
  color: black; }

span.Operator {
  color: black; }

span.Punctuation {
  color: black; }

span.Comment, span.LongComment {
  font-style: italic;
  font-weight: 400;
  color: #484a86; }

span.RegularExpression {
  color: darkviolet; }

span.TagStart {
  color: darkviolet; }

span.TagEnd {
  color: darkviolet; }

span.Key {
  color: #252dbe; }

span.Value {
  color: #252dbe; }

span.RawData {
  color: #a4255b; }

span.Assembler {
  color: #252dbe; }

span.Preprocessor {
  color: #252dbe; }

span.Directive {
  color: #252dbe; }

span.Command, span.Rule, span.Hyperlink, span.Label, span.Reference,
span.Other {
  color: black; }

/* Pop type, const, proc, and iterator defs in nim def blocks */
dt pre > span.Identifier, dt pre > span.Operator {
  color: #155da4;
  font-weight: 700; }

dt pre > span.Identifier ~ span.Identifier, dt pre > span.Operator ~ span.Identifier {
  color: inherit;
  font-weight: inherit; }

dt pre > span.Operator ~ span.Identifier, dt pre > span.Operator ~ span.Operator {
  color: inherit;
  font-weight: inherit; }

/* Nim sprite for the footer (taken from main page favicon) */
.nim-sprite {
  display: inline-block;
  height: 12px;
  width: 12px;
  background-position: 0 0;
  background-size: 12px 12px;
  -webkit-filter: opacity(50%);
  background-repeat: no-repeat;
  background-image: url("data:image/x-icon;base64,AAABAAEAEBAAAAEAIABoBAAAFgAAACgAAAAQAAAAIAAAAAEAIAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AAAAAAUAAAAF////AP///wD///8A////AP///wD///8A////AP///wD///8A////AAAAAAIAAABbAAAAlQAAAKIAAACbAAAAmwAAAKIAAACVAAAAWwAAAAL///8A////AP///wD///8A////AAAAABQAAADAAAAAYwAAAA3///8A////AP///wD///8AAAAADQAAAGMAAADAAAAAFP///wD///8A////AP///wAAAACdAAAAOv///wD///8A////AP///wD///8A////AP///wD///8AAAAAOgAAAJ3///8A////AP///wAAAAAnAAAAcP///wAAAAAoAAAASv///wD///8A////AP///wAAAABKAAAAKP///wAAAABwAAAAJ////wD///8AAAAAgQAAABwAAACIAAAAkAAAAJMAAACtAAAAFQAAABUAAACtAAAAkwAAAJAAAACIAAAAHAAAAIH///8A////AAAAAKQAAACrAAAAaP///wD///8AAAAARQAAANIAAADSAAAARf///wD///8AAAAAaAAAAKsAAACk////AAAAADMAAACcAAAAnQAAABj///8A////AP///wAAAAAYAAAAGP///wD///8A////AAAAABgAAACdAAAAnAAAADMAAAB1AAAAwwAAAP8AAADpAAAAsQAAAE4AAAAb////AP///wAAAAAbAAAATgAAALEAAADpAAAA/wAAAMMAAAB1AAAAtwAAAOkAAAD/AAAA/wAAAP8AAADvAAAA3gAAAN4AAADeAAAA3gAAAO8AAAD/AAAA/wAAAP8AAADpAAAAtwAAAGUAAAA/AAAA3wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAADfAAAAPwAAAGX///8A////AAAAAEgAAADtAAAAvwAAAL0AAADGAAAA7wAAAO8AAADGAAAAvQAAAL8AAADtAAAASP///wD///8A////AP///wD///8AAAAAO////wD///8A////AAAAAIcAAACH////AP///wD///8AAAAAO////wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A//8AAP//AAD4HwAA7/cAAN/7AAD//wAAoYUAAJ55AACf+QAAh+EAAAAAAADAAwAA4AcAAP5/AAD//wAA//8AAA==");
  margin-bottom: -5px; }
  div.pragma {
    display: none;
  }
  span.pragmabegin {
    cursor: pointer;
  }
  span.pragmaend {
    cursor: pointer;
  }

div.search_results {
  background-color: antiquewhite;
  margin: 3em;
  padding: 1em;
  border: 1px solid #4d4d4d;
}
</style>

<script type="text/javascript" src="../dochack.js"></script>

<script type="text/javascript">
function togglepragma(d) {
  if (d.style.display != 'inline')
    d.style.display = 'inline';
  else
    d.style.display = 'none';
}

function main() {
  var elements = document.getElementsByClassName("pragmabegin");
  for (var i = 0; i < elements.length; ++i) {
    var e = elements[i];
    e.onclick = function(event) {
      togglepragma(event.target.nextSibling);
    };
  }
  var elements = document.getElementsByClassName("pragmaend");
  for (var i = 0; i < elements.length; ++i) {
    var e = elements[i];
    e.onclick = function(event) {
      togglepragma(event.target.previousSibling);
    };
  }
}
</script>

</head>
<body onload="main()">
<div class="document" id="documentId">
  <div class="container">
    <h1 class="title">Module asyncftpclient</h1>
    <div class="row">
  <div class="three columns">
  <div>
    Search: <input type="text" id="searchInput"
      onkeyup="search()" />
  </div>
  <div>
    Group by:
    <select onchange="groupBy(this.value)">
      <option value="section">Section</option>
      <option value="type">Type</option>
    </select>
  </div>
  <ul class="simple simple-toc" id="toc-list">
<li><a class="reference" id="connecting-to-an-ftp-server_toc" href="#connecting-to-an-ftp-server">Connecting to an FTP server</a></li>
<li><a class="reference" id="uploading-a-new-file_toc" href="#uploading-a-new-file">Uploading a new file</a></li>
<li><a class="reference" id="checking-the-progress-of-a-file-transfer_toc" href="#checking-the-progress-of-a-file-transfer">Checking the progress of a file transfer</a></li>
<li>
  <a class="reference reference-toplevel" href="#6" id="56">Imports</a>
  <ul class="simple simple-toc-section">
    
  </ul>
</li>
<li>
  <a class="reference reference-toplevel" href="#7" id="57">Types</a>
  <ul class="simple simple-toc-section">
      <li><a class="reference" href="#AsyncFtpClientObj"
    title="AsyncFtpClientObj = FtpBaseObj[AsyncSocket]"><wbr />Async<wbr />Ftp<wbr />Client<wbr />Obj<span class="attachedType" style="visibility:hidden"></span></a></li>
  <li><a class="reference" href="#AsyncFtpClient"
    title="AsyncFtpClient = ref AsyncFtpClientObj"><wbr />Async<wbr />Ftp<wbr />Client<span class="attachedType" style="visibility:hidden"></span></a></li>
  <li><a class="reference" href="#ProgressChangedProc"
    title="ProgressChangedProc = proc (total, progress: BiggestInt; speed: float): Future[void]"><wbr />Progress<wbr />Changed<wbr />Proc<span class="attachedType" style="visibility:hidden"></span></a></li>

  </ul>
</li>
<li>
  <a class="reference reference-toplevel" href="#12" id="62">Procs</a>
  <ul class="simple simple-toc-section">
      <li><a class="reference" href="#send,AsyncFtpClient,string"
    title="send(ftp: AsyncFtpClient; m: string): Future[TaintedString]"><wbr />send<span class="attachedType" style="visibility:hidden">AsyncFtpClient</span></a></li>
  <li><a class="reference" href="#connect,AsyncFtpClient"
    title="connect(ftp: AsyncFtpClient): Future[void]"><wbr />connect<span class="attachedType" style="visibility:hidden">AsyncFtpClient</span></a></li>
  <li><a class="reference" href="#pwd,AsyncFtpClient"
    title="pwd(ftp: AsyncFtpClient): Future[TaintedString]"><wbr />pwd<span class="attachedType" style="visibility:hidden">AsyncFtpClient</span></a></li>
  <li><a class="reference" href="#cd,AsyncFtpClient,string"
    title="cd(ftp: AsyncFtpClient; dir: string): Future[void]"><wbr />cd<span class="attachedType" style="visibility:hidden">AsyncFtpClient</span></a></li>
  <li><a class="reference" href="#cdup,AsyncFtpClient"
    title="cdup(ftp: AsyncFtpClient): Future[void]"><wbr />cdup<span class="attachedType" style="visibility:hidden">AsyncFtpClient</span></a></li>
  <li><a class="reference" href="#listDirs,AsyncFtpClient,string"
    title="listDirs(ftp: AsyncFtpClient; dir = &quot;&quot;): Future[seq[string]]"><wbr />list<wbr />Dirs<span class="attachedType" style="visibility:hidden">AsyncFtpClient</span></a></li>
  <li><a class="reference" href="#existsFile,AsyncFtpClient,string"
    title="existsFile(ftp: AsyncFtpClient; file: string): Future[bool]"><wbr />exists<wbr />File<span class="attachedType" style="visibility:hidden">AsyncFtpClient</span></a></li>
  <li><a class="reference" href="#createDir,AsyncFtpClient,string"
    title="createDir(ftp: AsyncFtpClient; dir: string; recursive = false): Future[void]"><wbr />create<wbr />Dir<span class="attachedType" style="visibility:hidden">AsyncFtpClient</span></a></li>
  <li><a class="reference" href="#chmod,AsyncFtpClient,string,set[FilePermission]"
    title="chmod(ftp: AsyncFtpClient; path: string; permissions: set[FilePermission]): Future[
    void]"><wbr />chmod<span class="attachedType" style="visibility:hidden">AsyncFtpClient</span></a></li>
  <li><a class="reference" href="#list,AsyncFtpClient,string"
    title="list(ftp: AsyncFtpClient; dir = &quot;&quot;): Future[string]"><wbr />list<span class="attachedType" style="visibility:hidden">AsyncFtpClient</span></a></li>
  <li><a class="reference" href="#retrText,AsyncFtpClient,string"
    title="retrText(ftp: AsyncFtpClient; file: string): Future[string]"><wbr />retr<wbr />Text<span class="attachedType" style="visibility:hidden">AsyncFtpClient</span></a></li>
  <li><a class="reference" href="#defaultOnProgressChanged,BiggestInt,BiggestInt,float"
    title="defaultOnProgressChanged(total, progress: BiggestInt; speed: float): Future[void]"><wbr />default<wbr />On<wbr />Progress<wbr />Changed<span class="attachedType" style="visibility:hidden"></span></a></li>
  <li><a class="reference" href="#retrFile,AsyncFtpClient,string,string,ProgressChangedProc"
    title="retrFile(ftp: AsyncFtpClient; file, dest: string;
         onProgressChanged: ProgressChangedProc = defaultOnProgressChanged): Future[
    void]"><wbr />retr<wbr />File<span class="attachedType" style="visibility:hidden">AsyncFtpClient</span></a></li>
  <li><a class="reference" href="#store,AsyncFtpClient,string,string,ProgressChangedProc"
    title="store(ftp: AsyncFtpClient; file, dest: string;
      onProgressChanged: ProgressChangedProc = defaultOnProgressChanged): Future[
    void]"><wbr />store<span class="attachedType" style="visibility:hidden">AsyncFtpClient</span></a></li>
  <li><a class="reference" href="#rename,AsyncFtpClient,string,string"
    title="rename(ftp: AsyncFtpClient; nameFrom: string; nameTo: string): Future[void]"><wbr />rename<span class="attachedType" style="visibility:hidden">AsyncFtpClient</span></a></li>
  <li><a class="reference" href="#removeFile,AsyncFtpClient,string"
    title="removeFile(ftp: AsyncFtpClient; filename: string): Future[void]"><wbr />remove<wbr />File<span class="attachedType" style="visibility:hidden">AsyncFtpClient</span></a></li>
  <li><a class="reference" href="#removeDir,AsyncFtpClient,string"
    title="removeDir(ftp: AsyncFtpClient; dir: string): Future[void]"><wbr />remove<wbr />Dir<span class="attachedType" style="visibility:hidden">AsyncFtpClient</span></a></li>
  <li><a class="reference" href="#newAsyncFtpClient,string,string,string"
    title="newAsyncFtpClient(address: string; port = Port(21); user, pass = &quot;&quot;): AsyncFtpClient"><wbr />new<wbr />Async<wbr />Ftp<wbr />Client<span class="attachedType" style="visibility:hidden">AsyncFtpClient</span></a></li>

  </ul>
</li>

</ul>

  </div>
  <div class="nine columns" id="content">
  <div id="tocRoot"></div>
  <p class="module-desc">This module implements an asynchronous FTP client. It allows you to connect to an FTP server and perform operations on it such as for example:<ul class="simple"><li>The upload of new files.</li>
<li>The removal of existing files.</li>
<li>Download of files.</li>
<li>Changing of files' permissions.</li>
<li>Navigation through the FTP server's directories.</li>
</ul>

<h1><a class="toc-backref" id="connecting-to-an-ftp-server" href="#connecting-to-an-ftp-server">Connecting to an FTP server</a></h1><p>In order to begin any sort of transfer of files you must first connect to an FTP server. You can do so with the <tt class="docutils literal"><span class="pre">connect</span></tt> procedure.</p>
<blockquote><p><pre class = "listing"><span class="Keyword">import</span> <span class="Identifier">asyncdispatch</span><span class="Punctuation">,</span> <span class="Identifier">asyncftpclient</span>
<span class="Keyword">proc</span> <span class="Identifier">main</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Punctuation">{</span><span class="Operator">.</span><span class="Identifier">async</span><span class="Operator">.</span><span class="Punctuation">}</span> <span class="Operator">=</span>
  <span class="Keyword">var</span> <span class="Identifier">ftp</span> <span class="Operator">=</span> <span class="Identifier">newAsyncFtpClient</span><span class="Punctuation">(</span><span class="StringLit">&quot;example.com&quot;</span><span class="Punctuation">,</span> <span class="Identifier">user</span> <span class="Operator">=</span> <span class="StringLit">&quot;test&quot;</span><span class="Punctuation">,</span> <span class="Identifier">pass</span> <span class="Operator">=</span> <span class="StringLit">&quot;test&quot;</span><span class="Punctuation">)</span>
  <span class="Identifier">await</span> <span class="Identifier">ftp</span><span class="Operator">.</span><span class="Identifier">connect</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
  <span class="Identifier">echo</span><span class="Punctuation">(</span><span class="StringLit">&quot;Connected&quot;</span><span class="Punctuation">)</span>
<span class="Identifier">waitFor</span><span class="Punctuation">(</span><span class="Identifier">main</span><span class="Punctuation">(</span><span class="Punctuation">)</span><span class="Punctuation">)</span></pre></p></blockquote>
<p>A new <tt class="docutils literal"><span class="pre">main</span></tt> async procedure must be declared to allow the use of the <tt class="docutils literal"><span class="pre">await</span></tt> keyword. The connection will complete asynchronously and the client will be connected after the <tt class="docutils literal"><span class="pre">await ftp.connect()</span></tt> call.</p>

<h1><a class="toc-backref" id="uploading-a-new-file" href="#uploading-a-new-file">Uploading a new file</a></h1><p>After a connection is made you can use the <tt class="docutils literal"><span class="pre">store</span></tt> procedure to upload a new file to the FTP server. Make sure to check you are in the correct working directory before you do so with the <tt class="docutils literal"><span class="pre">pwd</span></tt> procedure, you can also instead specify an absolute path.</p>
<blockquote><p><pre class = "listing"><span class="Keyword">import</span> <span class="Identifier">asyncdispatch</span><span class="Punctuation">,</span> <span class="Identifier">asyncftpclient</span>
<span class="Keyword">proc</span> <span class="Identifier">main</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Punctuation">{</span><span class="Operator">.</span><span class="Identifier">async</span><span class="Operator">.</span><span class="Punctuation">}</span> <span class="Operator">=</span>
  <span class="Keyword">var</span> <span class="Identifier">ftp</span> <span class="Operator">=</span> <span class="Identifier">newAsyncFtpClient</span><span class="Punctuation">(</span><span class="StringLit">&quot;example.com&quot;</span><span class="Punctuation">,</span> <span class="Identifier">user</span> <span class="Operator">=</span> <span class="StringLit">&quot;test&quot;</span><span class="Punctuation">,</span> <span class="Identifier">pass</span> <span class="Operator">=</span> <span class="StringLit">&quot;test&quot;</span><span class="Punctuation">)</span>
  <span class="Identifier">await</span> <span class="Identifier">ftp</span><span class="Operator">.</span><span class="Identifier">connect</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
  <span class="Keyword">let</span> <span class="Identifier">currentDir</span> <span class="Operator">=</span> <span class="Identifier">await</span> <span class="Identifier">ftp</span><span class="Operator">.</span><span class="Identifier">pwd</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
  <span class="Identifier">assert</span> <span class="Identifier">currentDir</span> <span class="Operator">==</span> <span class="StringLit">&quot;/home/user/&quot;</span>
  <span class="Identifier">await</span> <span class="Identifier">ftp</span><span class="Operator">.</span><span class="Identifier">store</span><span class="Punctuation">(</span><span class="StringLit">&quot;file.txt&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;file.txt&quot;</span><span class="Punctuation">)</span>
  <span class="Identifier">echo</span><span class="Punctuation">(</span><span class="StringLit">&quot;File finished uploading&quot;</span><span class="Punctuation">)</span>
<span class="Identifier">waitFor</span><span class="Punctuation">(</span><span class="Identifier">main</span><span class="Punctuation">(</span><span class="Punctuation">)</span><span class="Punctuation">)</span></pre></p></blockquote>

<h1><a class="toc-backref" id="checking-the-progress-of-a-file-transfer" href="#checking-the-progress-of-a-file-transfer">Checking the progress of a file transfer</a></h1><p>The progress of either a file upload or a file download can be checked by specifying a <tt class="docutils literal"><span class="pre">onProgressChanged</span></tt> procedure to the <tt class="docutils literal"><span class="pre">store</span></tt> or <tt class="docutils literal"><span class="pre">retrFile</span></tt> procedures.</p>
<blockquote><p><pre class = "listing"><span class="Keyword">import</span> <span class="Identifier">asyncdispatch</span><span class="Punctuation">,</span> <span class="Identifier">asyncftpclient</span>

<span class="Keyword">proc</span> <span class="Identifier">onProgressChanged</span><span class="Punctuation">(</span><span class="Identifier">total</span><span class="Punctuation">,</span> <span class="Identifier">progress</span><span class="Punctuation">:</span> <span class="Identifier">BiggestInt</span><span class="Punctuation">,</span>
                        <span class="Identifier">speed</span><span class="Punctuation">:</span> <span class="Identifier">float</span><span class="Punctuation">)</span><span class="Punctuation">:</span> <span class="Identifier">Future</span><span class="Punctuation">[</span><span class="Identifier">void</span><span class="Punctuation">]</span> <span class="Operator">=</span>
  <span class="Identifier">echo</span><span class="Punctuation">(</span><span class="StringLit">&quot;Uploaded &quot;</span><span class="Punctuation">,</span> <span class="Identifier">progress</span><span class="Punctuation">,</span> <span class="StringLit">&quot; of &quot;</span><span class="Punctuation">,</span> <span class="Identifier">total</span><span class="Punctuation">,</span> <span class="StringLit">&quot; bytes&quot;</span><span class="Punctuation">)</span>
  <span class="Identifier">echo</span><span class="Punctuation">(</span><span class="StringLit">&quot;Current speed: &quot;</span><span class="Punctuation">,</span> <span class="Identifier">speed</span><span class="Punctuation">,</span> <span class="StringLit">&quot; kb/s&quot;</span><span class="Punctuation">)</span>

<span class="Keyword">proc</span> <span class="Identifier">main</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Punctuation">{</span><span class="Operator">.</span><span class="Identifier">async</span><span class="Operator">.</span><span class="Punctuation">}</span> <span class="Operator">=</span>
  <span class="Keyword">var</span> <span class="Identifier">ftp</span> <span class="Operator">=</span> <span class="Identifier">newAsyncFtpClient</span><span class="Punctuation">(</span><span class="StringLit">&quot;example.com&quot;</span><span class="Punctuation">,</span> <span class="Identifier">user</span> <span class="Operator">=</span> <span class="StringLit">&quot;test&quot;</span><span class="Punctuation">,</span> <span class="Identifier">pass</span> <span class="Operator">=</span> <span class="StringLit">&quot;test&quot;</span><span class="Punctuation">)</span>
  <span class="Identifier">await</span> <span class="Identifier">ftp</span><span class="Operator">.</span><span class="Identifier">connect</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
  <span class="Identifier">await</span> <span class="Identifier">ftp</span><span class="Operator">.</span><span class="Identifier">store</span><span class="Punctuation">(</span><span class="StringLit">&quot;file.txt&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;/home/user/file.txt&quot;</span><span class="Punctuation">,</span> <span class="Identifier">onProgressChanged</span><span class="Punctuation">)</span>
  <span class="Identifier">echo</span><span class="Punctuation">(</span><span class="StringLit">&quot;File finished uploading&quot;</span><span class="Punctuation">)</span>
<span class="Identifier">waitFor</span><span class="Punctuation">(</span><span class="Identifier">main</span><span class="Punctuation">(</span><span class="Punctuation">)</span><span class="Punctuation">)</span></pre></p></blockquote>
</p>
  <div class="section" id="6">
<h1><a class="toc-backref" href="#6">Imports</a></h1>
<dl class="item">
<a class="reference external" href="asyncdispatch.html">asyncdispatch</a>, <a class="reference external" href="asyncnet.html">asyncnet</a>, <a class="reference external" href="strutils.html">strutils</a>, <a class="reference external" href="parseutils.html">parseutils</a>, <a class="reference external" href="os.html">os</a>, <a class="reference external" href="times.html">times</a>, <a class="reference external" href="ftpclient.html">ftpclient</a>, <a class="reference external" href="net.html">net</a>
</dl></div>
<div class="section" id="7">
<h1><a class="toc-backref" href="#7">Types</a></h1>
<dl class="item">
<dt id="AsyncFtpClientObj"><a name="AsyncFtpClientObj"></a><pre><span class="Identifier">AsyncFtpClientObj</span> <span class="Other">=</span> <span class="Identifier">FtpBaseObj</span><span class="Other">[</span><span class="Identifier">AsyncSocket</span><span class="Other">]</span></pre></dt>
<dd>

&nbsp;&nbsp;<a
href="https://github.com/nim-lang/Nim/tree/master/lib/pure/asyncftpclient.nim#L84"
class="link-seesrc" target="_blank">Source</a>
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/asyncftpclient.nim#L84" class="link-seesrc" target="_blank" >Edit</a>

</dd>
<dt id="AsyncFtpClient"><a name="AsyncFtpClient"></a><pre><span class="Identifier">AsyncFtpClient</span> <span class="Other">=</span> <span class="Keyword">ref</span> <span class="Identifier">AsyncFtpClientObj</span></pre></dt>
<dd>

&nbsp;&nbsp;<a
href="https://github.com/nim-lang/Nim/tree/master/lib/pure/asyncftpclient.nim#L85"
class="link-seesrc" target="_blank">Source</a>
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/asyncftpclient.nim#L85" class="link-seesrc" target="_blank" >Edit</a>

</dd>
<dt id="ProgressChangedProc"><a name="ProgressChangedProc"></a><pre><span class="Identifier">ProgressChangedProc</span> <span class="Other">=</span> <span class="Keyword">proc</span> <span class="Other">(</span><span class="Identifier">total</span><span class="Other">,</span> <span class="Identifier">progress</span><span class="Other">:</span> <span class="Identifier">BiggestInt</span><span class="Other">;</span> <span class="Identifier">speed</span><span class="Other">:</span> <span class="Identifier">float</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Future</span><span class="Other">[</span><span class="Identifier">void</span><span class="Other">]</span> <span class="Other pragmabegin">{.</span><div class="pragma">
    <span class="Identifier">closure</span><span class="Other">,</span> <span class="Identifier">gcsafe</span></div><span class="Other pragmaend">.}</span></pre></dt>
<dd>

&nbsp;&nbsp;<a
href="https://github.com/nim-lang/Nim/tree/master/lib/pure/asyncftpclient.nim#L87"
class="link-seesrc" target="_blank">Source</a>
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/asyncftpclient.nim#L87" class="link-seesrc" target="_blank" >Edit</a>

</dd>

</dl></div>
<div class="section" id="12">
<h1><a class="toc-backref" href="#12">Procs</a></h1>
<dl class="item">
<dt id="send"><a name="send,AsyncFtpClient,string"></a><pre><span class="Keyword">proc</span> <span class="Identifier">send</span><span class="Other">(</span><span class="Identifier">ftp</span><span class="Other">:</span> <span class="Identifier">AsyncFtpClient</span><span class="Other">;</span> <span class="Identifier">m</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Future</span><span class="Other">[</span><span class="Identifier">TaintedString</span><span class="Other">]</span> <span class="Other pragmabegin">{.</span><div class="pragma">
    <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">FutureError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span></div><span class="Other pragmaend">.}</span></pre></dt>
<dd>
<p>Send a message to the server, and wait for a primary reply. <tt class="docutils literal"><span class="pre">\c\L</span></tt> is added for you.</p>
<p><strong>Note:</strong> The server may return multiple lines of coded replies.</p>

&nbsp;&nbsp;<a
href="https://github.com/nim-lang/Nim/tree/master/lib/pure/asyncftpclient.nim#L104"
class="link-seesrc" target="_blank">Source</a>
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/asyncftpclient.nim#L104" class="link-seesrc" target="_blank" >Edit</a>

</dd>
<dt id="connect"><a name="connect,AsyncFtpClient"></a><pre><span class="Keyword">proc</span> <span class="Identifier">connect</span><span class="Other">(</span><span class="Identifier">ftp</span><span class="Other">:</span> <span class="Identifier">AsyncFtpClient</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Future</span><span class="Other">[</span><span class="Identifier">void</span><span class="Other">]</span> <span class="Other pragmabegin">{.</span><div class="pragma"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">FutureError</span><span class="Other">]</span><span class="Other">,</span>
    <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span></div><span class="Other pragmaend">.}</span></pre></dt>
<dd>
Connect to the FTP server specified by <tt class="docutils literal"><span class="pre">ftp</span></tt>.
&nbsp;&nbsp;<a
href="https://github.com/nim-lang/Nim/tree/master/lib/pure/asyncftpclient.nim#L136"
class="link-seesrc" target="_blank">Source</a>
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/asyncftpclient.nim#L136" class="link-seesrc" target="_blank" >Edit</a>

</dd>
<dt id="pwd"><a name="pwd,AsyncFtpClient"></a><pre><span class="Keyword">proc</span> <span class="Identifier">pwd</span><span class="Other">(</span><span class="Identifier">ftp</span><span class="Other">:</span> <span class="Identifier">AsyncFtpClient</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Future</span><span class="Other">[</span><span class="Identifier">TaintedString</span><span class="Other">]</span> <span class="Other pragmabegin">{.</span><div class="pragma"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">FutureError</span><span class="Other">]</span><span class="Other">,</span>
    <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span></div><span class="Other pragmaend">.}</span></pre></dt>
<dd>
Returns the current working directory.
&nbsp;&nbsp;<a
href="https://github.com/nim-lang/Nim/tree/master/lib/pure/asyncftpclient.nim#L155"
class="link-seesrc" target="_blank">Source</a>
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/asyncftpclient.nim#L155" class="link-seesrc" target="_blank" >Edit</a>

</dd>
<dt id="cd"><a name="cd,AsyncFtpClient,string"></a><pre><span class="Keyword">proc</span> <span class="Identifier">cd</span><span class="Other">(</span><span class="Identifier">ftp</span><span class="Other">:</span> <span class="Identifier">AsyncFtpClient</span><span class="Other">;</span> <span class="Identifier">dir</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Future</span><span class="Other">[</span><span class="Identifier">void</span><span class="Other">]</span> <span class="Other pragmabegin">{.</span><div class="pragma"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">FutureError</span><span class="Other">]</span><span class="Other">,</span>
    <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span></div><span class="Other pragmaend">.}</span></pre></dt>
<dd>
Changes the current directory on the remote FTP server to <tt class="docutils literal"><span class="pre">dir</span></tt>.
&nbsp;&nbsp;<a
href="https://github.com/nim-lang/Nim/tree/master/lib/pure/asyncftpclient.nim#L161"
class="link-seesrc" target="_blank">Source</a>
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/asyncftpclient.nim#L161" class="link-seesrc" target="_blank" >Edit</a>

</dd>
<dt id="cdup"><a name="cdup,AsyncFtpClient"></a><pre><span class="Keyword">proc</span> <span class="Identifier">cdup</span><span class="Other">(</span><span class="Identifier">ftp</span><span class="Other">:</span> <span class="Identifier">AsyncFtpClient</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Future</span><span class="Other">[</span><span class="Identifier">void</span><span class="Other">]</span> <span class="Other pragmabegin">{.</span><div class="pragma"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">FutureError</span><span class="Other">]</span><span class="Other">,</span>
    <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span></div><span class="Other pragmaend">.}</span></pre></dt>
<dd>
Changes the current directory to the parent of the current directory.
&nbsp;&nbsp;<a
href="https://github.com/nim-lang/Nim/tree/master/lib/pure/asyncftpclient.nim#L165"
class="link-seesrc" target="_blank">Source</a>
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/asyncftpclient.nim#L165" class="link-seesrc" target="_blank" >Edit</a>

</dd>
<dt id="listDirs"><a name="listDirs,AsyncFtpClient,string"></a><pre><span class="Keyword">proc</span> <span class="Identifier">listDirs</span><span class="Other">(</span><span class="Identifier">ftp</span><span class="Other">:</span> <span class="Identifier">AsyncFtpClient</span><span class="Other">;</span> <span class="Identifier">dir</span> <span class="Other">=</span> <span class="StringLit">&quot;&quot;</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Future</span><span class="Other">[</span><span class="Identifier">seq</span><span class="Other">[</span><span class="Identifier">string</span><span class="Other">]</span><span class="Other">]</span> <span class="Other pragmabegin">{.</span><div class="pragma">
    <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">FutureError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span></div><span class="Other pragmaend">.}</span></pre></dt>
<dd>
Returns a list of filenames in the given directory. If <tt class="docutils literal"><span class="pre">dir</span></tt> is &quot;&quot;, the current directory is used. If <tt class="docutils literal"><span class="pre">async</span></tt> is true, this function will return immediately and it will be your job to use asyncio's <tt class="docutils literal"><span class="pre">poll</span></tt> to progress this operation.
&nbsp;&nbsp;<a
href="https://github.com/nim-lang/Nim/tree/master/lib/pure/asyncftpclient.nim#L182"
class="link-seesrc" target="_blank">Source</a>
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/asyncftpclient.nim#L182" class="link-seesrc" target="_blank" >Edit</a>

</dd>
<dt id="existsFile"><a name="existsFile,AsyncFtpClient,string"></a><pre><span class="Keyword">proc</span> <span class="Identifier">existsFile</span><span class="Other">(</span><span class="Identifier">ftp</span><span class="Other">:</span> <span class="Identifier">AsyncFtpClient</span><span class="Other">;</span> <span class="Identifier">file</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Future</span><span class="Other">[</span><span class="Identifier">bool</span><span class="Other">]</span> <span class="Other pragmabegin">{.</span><div class="pragma">
    <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">FutureError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span></div><span class="Other pragmaend">.}</span></pre></dt>
<dd>
Determines whether <tt class="docutils literal"><span class="pre">file</span></tt> exists.
&nbsp;&nbsp;<a
href="https://github.com/nim-lang/Nim/tree/master/lib/pure/asyncftpclient.nim#L193"
class="link-seesrc" target="_blank">Source</a>
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/asyncftpclient.nim#L193" class="link-seesrc" target="_blank" >Edit</a>

</dd>
<dt id="createDir"><a name="createDir,AsyncFtpClient,string"></a><pre><span class="Keyword">proc</span> <span class="Identifier">createDir</span><span class="Other">(</span><span class="Identifier">ftp</span><span class="Other">:</span> <span class="Identifier">AsyncFtpClient</span><span class="Other">;</span> <span class="Identifier">dir</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">;</span> <span class="Identifier">recursive</span> <span class="Other">=</span> <span class="Identifier">false</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Future</span><span class="Other">[</span><span class="Identifier">void</span><span class="Other">]</span> <span class="Other pragmabegin">{.</span><div class="pragma">
    <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">FutureError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span></div><span class="Other pragmaend">.}</span></pre></dt>
<dd>
Creates a directory <tt class="docutils literal"><span class="pre">dir</span></tt>. If <tt class="docutils literal"><span class="pre">recursive</span></tt> is true, the topmost subdirectory of <tt class="docutils literal"><span class="pre">dir</span></tt> will be created first, following the secondmost... etc. this allows you to give a full path as the <tt class="docutils literal"><span class="pre">dir</span></tt> without worrying about subdirectories not existing.
&nbsp;&nbsp;<a
href="https://github.com/nim-lang/Nim/tree/master/lib/pure/asyncftpclient.nim#L199"
class="link-seesrc" target="_blank">Source</a>
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/asyncftpclient.nim#L199" class="link-seesrc" target="_blank" >Edit</a>

</dd>
<dt id="chmod"><a name="chmod,AsyncFtpClient,string,set[FilePermission]"></a><pre><span class="Keyword">proc</span> <span class="Identifier">chmod</span><span class="Other">(</span><span class="Identifier">ftp</span><span class="Other">:</span> <span class="Identifier">AsyncFtpClient</span><span class="Other">;</span> <span class="Identifier">path</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">;</span> <span class="Identifier">permissions</span><span class="Other">:</span> <span class="Identifier">set</span><span class="Other">[</span><span class="Identifier">FilePermission</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Future</span><span class="Other">[</span>
    <span class="Identifier">void</span><span class="Other">]</span> <span class="Other pragmabegin">{.</span><div class="pragma"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">FutureError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span></div><span class="Other pragmaend">.}</span></pre></dt>
<dd>
Changes permission of <tt class="docutils literal"><span class="pre">path</span></tt> to <tt class="docutils literal"><span class="pre">permissions</span></tt>.
&nbsp;&nbsp;<a
href="https://github.com/nim-lang/Nim/tree/master/lib/pure/asyncftpclient.nim#L217"
class="link-seesrc" target="_blank">Source</a>
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/asyncftpclient.nim#L217" class="link-seesrc" target="_blank" >Edit</a>

</dd>
<dt id="list"><a name="list,AsyncFtpClient,string"></a><pre><span class="Keyword">proc</span> <span class="Identifier">list</span><span class="Other">(</span><span class="Identifier">ftp</span><span class="Other">:</span> <span class="Identifier">AsyncFtpClient</span><span class="Other">;</span> <span class="Identifier">dir</span> <span class="Other">=</span> <span class="StringLit">&quot;&quot;</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Future</span><span class="Other">[</span><span class="Identifier">string</span><span class="Other">]</span> <span class="Other pragmabegin">{.</span><div class="pragma"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">FutureError</span><span class="Other">]</span><span class="Other">,</span>
    <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span></div><span class="Other pragmaend">.}</span></pre></dt>
<dd>
Lists all files in <tt class="docutils literal"><span class="pre">dir</span></tt>. If <tt class="docutils literal"><span class="pre">dir</span></tt> is <tt class="docutils literal"><span class="pre">&quot;&quot;</span></tt>, uses the current working directory.
&nbsp;&nbsp;<a
href="https://github.com/nim-lang/Nim/tree/master/lib/pure/asyncftpclient.nim#L238"
class="link-seesrc" target="_blank">Source</a>
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/asyncftpclient.nim#L238" class="link-seesrc" target="_blank" >Edit</a>

</dd>
<dt id="retrText"><a name="retrText,AsyncFtpClient,string"></a><pre><span class="Keyword">proc</span> <span class="Identifier">retrText</span><span class="Other">(</span><span class="Identifier">ftp</span><span class="Other">:</span> <span class="Identifier">AsyncFtpClient</span><span class="Other">;</span> <span class="Identifier">file</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Future</span><span class="Other">[</span><span class="Identifier">string</span><span class="Other">]</span> <span class="Other pragmabegin">{.</span><div class="pragma">
    <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">FutureError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span></div><span class="Other pragmaend">.}</span></pre></dt>
<dd>
Retrieves <tt class="docutils literal"><span class="pre">file</span></tt>. File must be ASCII text.
&nbsp;&nbsp;<a
href="https://github.com/nim-lang/Nim/tree/master/lib/pure/asyncftpclient.nim#L248"
class="link-seesrc" target="_blank">Source</a>
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/asyncftpclient.nim#L248" class="link-seesrc" target="_blank" >Edit</a>

</dd>
<dt id="defaultOnProgressChanged"><a name="defaultOnProgressChanged,BiggestInt,BiggestInt,float"></a><pre><span class="Keyword">proc</span> <span class="Identifier">defaultOnProgressChanged</span><span class="Other">(</span><span class="Identifier">total</span><span class="Other">,</span> <span class="Identifier">progress</span><span class="Other">:</span> <span class="Identifier">BiggestInt</span><span class="Other">;</span> <span class="Identifier">speed</span><span class="Other">:</span> <span class="Identifier">float</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Future</span><span class="Other">[</span><span class="Identifier">void</span><span class="Other">]</span> <span class="Other pragmabegin">{.</span><div class="pragma">
    <span class="Identifier">nimcall</span><span class="Other">,</span> <span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">procvar</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">FutureError</span><span class="Other">,</span> <span class="Identifier">Exception</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span></div><span class="Other pragmaend">.}</span></pre></dt>
<dd>
Default FTP <tt class="docutils literal"><span class="pre">onProgressChanged</span></tt> handler. Does nothing.
&nbsp;&nbsp;<a
href="https://github.com/nim-lang/Nim/tree/master/lib/pure/asyncftpclient.nim#L283"
class="link-seesrc" target="_blank">Source</a>
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/asyncftpclient.nim#L283" class="link-seesrc" target="_blank" >Edit</a>

</dd>
<dt id="retrFile"><a name="retrFile,AsyncFtpClient,string,string,ProgressChangedProc"></a><pre><span class="Keyword">proc</span> <span class="Identifier">retrFile</span><span class="Other">(</span><span class="Identifier">ftp</span><span class="Other">:</span> <span class="Identifier">AsyncFtpClient</span><span class="Other">;</span> <span class="Identifier">file</span><span class="Other">,</span> <span class="Identifier">dest</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">;</span>
             <span class="Identifier">onProgressChanged</span><span class="Other">:</span> <span class="Identifier">ProgressChangedProc</span> <span class="Other">=</span> <span class="Identifier">defaultOnProgressChanged</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Future</span><span class="Other">[</span>
    <span class="Identifier">void</span><span class="Other">]</span> <span class="Other pragmabegin">{.</span><div class="pragma"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">FutureError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">,</span> <span class="Identifier">TimeEffect</span><span class="Other">,</span> <span class="Identifier">WriteIOEffect</span><span class="Other">]</span></div><span class="Other pragmaend">.}</span></pre></dt>
<dd>
Downloads <tt class="docutils literal"><span class="pre">file</span></tt> and saves it to <tt class="docutils literal"><span class="pre">dest</span></tt>. The <tt class="docutils literal"><span class="pre">EvRetr</span></tt> event is passed to the specified <tt class="docutils literal"><span class="pre">handleEvent</span></tt> function when the download is finished. The event's <tt class="docutils literal"><span class="pre">filename</span></tt> field will be equal to <tt class="docutils literal"><span class="pre">file</span></tt>.
&nbsp;&nbsp;<a
href="https://github.com/nim-lang/Nim/tree/master/lib/pure/asyncftpclient.nim#L291"
class="link-seesrc" target="_blank">Source</a>
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/asyncftpclient.nim#L291" class="link-seesrc" target="_blank" >Edit</a>

</dd>
<dt id="store"><a name="store,AsyncFtpClient,string,string,ProgressChangedProc"></a><pre><span class="Keyword">proc</span> <span class="Identifier">store</span><span class="Other">(</span><span class="Identifier">ftp</span><span class="Other">:</span> <span class="Identifier">AsyncFtpClient</span><span class="Other">;</span> <span class="Identifier">file</span><span class="Other">,</span> <span class="Identifier">dest</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">;</span>
          <span class="Identifier">onProgressChanged</span><span class="Other">:</span> <span class="Identifier">ProgressChangedProc</span> <span class="Other">=</span> <span class="Identifier">defaultOnProgressChanged</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Future</span><span class="Other">[</span>
    <span class="Identifier">void</span><span class="Other">]</span> <span class="Other pragmabegin">{.</span><div class="pragma"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">FutureError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">,</span> <span class="Identifier">ReadIOEffect</span><span class="Other">,</span> <span class="Identifier">TimeEffect</span><span class="Other">]</span></div><span class="Other pragmaend">.}</span></pre></dt>
<dd>
Uploads <tt class="docutils literal"><span class="pre">file</span></tt> to <tt class="docutils literal"><span class="pre">dest</span></tt> on the remote FTP server. Usage of this function asynchronously is recommended to view the progress of the download. The <tt class="docutils literal"><span class="pre">EvStore</span></tt> event is passed to the specified <tt class="docutils literal"><span class="pre">handleEvent</span></tt> function when the upload is finished, and the <tt class="docutils literal"><span class="pre">filename</span></tt> field will be equal to <tt class="docutils literal"><span class="pre">file</span></tt>.
&nbsp;&nbsp;<a
href="https://github.com/nim-lang/Nim/tree/master/lib/pure/asyncftpclient.nim#L342"
class="link-seesrc" target="_blank">Source</a>
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/asyncftpclient.nim#L342" class="link-seesrc" target="_blank" >Edit</a>

</dd>
<dt id="rename"><a name="rename,AsyncFtpClient,string,string"></a><pre><span class="Keyword">proc</span> <span class="Identifier">rename</span><span class="Other">(</span><span class="Identifier">ftp</span><span class="Other">:</span> <span class="Identifier">AsyncFtpClient</span><span class="Other">;</span> <span class="Identifier">nameFrom</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">;</span> <span class="Identifier">nameTo</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Future</span><span class="Other">[</span><span class="Identifier">void</span><span class="Other">]</span> <span class="Other pragmabegin">{.</span><div class="pragma">
    <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">FutureError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span></div><span class="Other pragmaend">.}</span></pre></dt>
<dd>
Rename a file or directory on the remote FTP Server from current name <tt class="docutils literal"><span class="pre">name_from</span></tt> to new name <tt class="docutils literal"><span class="pre">name_to</span></tt>
&nbsp;&nbsp;<a
href="https://github.com/nim-lang/Nim/tree/master/lib/pure/asyncftpclient.nim#L357"
class="link-seesrc" target="_blank">Source</a>
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/asyncftpclient.nim#L357" class="link-seesrc" target="_blank" >Edit</a>

</dd>
<dt id="removeFile"><a name="removeFile,AsyncFtpClient,string"></a><pre><span class="Keyword">proc</span> <span class="Identifier">removeFile</span><span class="Other">(</span><span class="Identifier">ftp</span><span class="Other">:</span> <span class="Identifier">AsyncFtpClient</span><span class="Other">;</span> <span class="Identifier">filename</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Future</span><span class="Other">[</span><span class="Identifier">void</span><span class="Other">]</span> <span class="Other pragmabegin">{.</span><div class="pragma">
    <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">FutureError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span></div><span class="Other pragmaend">.}</span></pre></dt>
<dd>
Delete a file <tt class="docutils literal"><span class="pre">filename</span></tt> on the remote FTP server
&nbsp;&nbsp;<a
href="https://github.com/nim-lang/Nim/tree/master/lib/pure/asyncftpclient.nim#L363"
class="link-seesrc" target="_blank">Source</a>
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/asyncftpclient.nim#L363" class="link-seesrc" target="_blank" >Edit</a>

</dd>
<dt id="removeDir"><a name="removeDir,AsyncFtpClient,string"></a><pre><span class="Keyword">proc</span> <span class="Identifier">removeDir</span><span class="Other">(</span><span class="Identifier">ftp</span><span class="Other">:</span> <span class="Identifier">AsyncFtpClient</span><span class="Other">;</span> <span class="Identifier">dir</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Future</span><span class="Other">[</span><span class="Identifier">void</span><span class="Other">]</span> <span class="Other pragmabegin">{.</span><div class="pragma">
    <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">FutureError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span></div><span class="Other pragmaend">.}</span></pre></dt>
<dd>
Delete a directory <tt class="docutils literal"><span class="pre">dir</span></tt> on the remote FTP server
&nbsp;&nbsp;<a
href="https://github.com/nim-lang/Nim/tree/master/lib/pure/asyncftpclient.nim#L367"
class="link-seesrc" target="_blank">Source</a>
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/asyncftpclient.nim#L367" class="link-seesrc" target="_blank" >Edit</a>

</dd>
<dt id="newAsyncFtpClient"><a name="newAsyncFtpClient,string,string,string"></a><pre><span class="Keyword">proc</span> <span class="Identifier">newAsyncFtpClient</span><span class="Other">(</span><span class="Identifier">address</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">;</span> <span class="Identifier">port</span> <span class="Other">=</span> <span class="Identifier">Port</span><span class="Other">(</span><span class="DecNumber">21</span><span class="Other">)</span><span class="Other">;</span> <span class="Identifier">user</span><span class="Other">,</span> <span class="Identifier">pass</span> <span class="Other">=</span> <span class="StringLit">&quot;&quot;</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">AsyncFtpClient</span> <span class="Other pragmabegin">{.</span><div class="pragma">
    <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">OSError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></div><span class="Other pragmaend">.}</span></pre></dt>
<dd>
Creates a new <tt class="docutils literal"><span class="pre">AsyncFtpClient</span></tt> object.
&nbsp;&nbsp;<a
href="https://github.com/nim-lang/Nim/tree/master/lib/pure/asyncftpclient.nim#L371"
class="link-seesrc" target="_blank">Source</a>
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/asyncftpclient.nim#L371" class="link-seesrc" target="_blank" >Edit</a>

</dd>

</dl></div>

  </div>
</div>

    <div class="row">
      <div class="twelve-columns footer">
        <span class="nim-sprite"></span>
        <br/>
        <small>Made with Nim. Generated: 2017-01-09 23:41:29 UTC</small>
      </div>
    </div>
  </div>
</div>

</body>
</html>
nim-doc 0.16.0-1 / usr / share / doc / nim-doc / html / asyncftpclient.html
