Packages

sealed trait FtpApi[FtpClient] extends AnyRef

Self Type
FtpApi[FtpClient] with FtpSourceFactory[FtpClient]
Source
FtpApi.scala
Linear Supertypes
AnyRef, Any
Known Subclasses
Ftp, Ftps, Sftp, SftpApi
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. FtpApi
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. abstract type S <: RemoteFileSettings

    The refined RemoteFileSettings type.

Abstract Value Members

  1. implicit abstract def ftpLike: FtpLike[FtpClient, (FtpApi.this)#S]
    Attributes
    protected[this]

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate() @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. def fromPath(path: String, connectionSettings: (FtpApi.this)#S, chunkSize: Int, offset: Long): Source[ByteString, Future[IOResult]]

    Scala API: creates a Source of ByteString from some file path.

    Scala API: creates a Source of ByteString from some file path.

    path

    the file path

    connectionSettings

    connection setting

    chunkSize

    the size of transmitted ByteString chunks

    offset

    the offset into the remote file at which to start the file transfer

    returns

    A Source of ByteString that materializes to a Future of IOResult

  9. def fromPath(path: String, connectionSettings: (FtpApi.this)#S, chunkSize: Int = DefaultChunkSize): Source[ByteString, Future[IOResult]]

    Scala API: creates a Source of ByteString from some file path.

    Scala API: creates a Source of ByteString from some file path.

    path

    the file path

    connectionSettings

    connection settings

    chunkSize

    the size of transmitted ByteString chunks

    returns

    A Source of ByteString that materializes to a Future of IOResult

  10. def fromPath(host: String, username: String, password: String, path: String): Source[ByteString, Future[IOResult]]

    Scala API: creates a Source of ByteString from some file path.

    Scala API: creates a Source of ByteString from some file path.

    host

    FTP, FTPs or SFTP host

    username

    username

    password

    password

    path

    the file path

    returns

    A Source of ByteString that materializes to a Future of IOResult

  11. def fromPath(host: String, path: String): Source[ByteString, Future[IOResult]]

    Scala API: creates a Source of ByteString from some file path.

    Scala API: creates a Source of ByteString from some file path.

    host

    FTP, FTPs or SFTP host

    path

    the file path

    returns

    A Source of ByteString that materializes to a Future of IOResult

  12. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  13. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  14. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  15. def ls(basePath: String, connectionSettings: (FtpApi.this)#S, branchSelector: (FtpFile) ⇒ Boolean, emitTraversedDirectories: Boolean): Source[FtpFile, NotUsed]

    Scala API: creates a Source of FtpFiles from a base path.

    Scala API: creates a Source of FtpFiles from a base path.

    basePath

    Base path from which traverse the remote file server

    connectionSettings

    connection settings

    branchSelector

    a function for pruning the tree. Takes a remote folder and return true if you want to enter that remote folder. Default behaviour is fully recursive which is equivalent with calling this function with [ls(basePath,connectionSettings,f=>true)]. Calling [ls(basePath,connectionSettings,f=>false)] will emit only the files and folder in non-recursive fashion

    emitTraversedDirectories

    whether to include entered directories in the stream

    returns

    A Source of FtpFiles

  16. def ls(basePath: String, connectionSettings: (FtpApi.this)#S, branchSelector: (FtpFile) ⇒ Boolean): Source[FtpFile, NotUsed]

    Scala API: creates a Source of FtpFiles from a base path.

    Scala API: creates a Source of FtpFiles from a base path.

    basePath

    Base path from which traverse the remote file server

    connectionSettings

    connection settings

    branchSelector

    a function for pruning the tree. Takes a remote folder and return true if you want to enter that remote folder. Default behaviour is fully recursive which is equivalent with calling this function with [ls(basePath,connectionSettings,f=>true)]. Calling [ls(basePath,connectionSettings,f=>false)] will emit only the files and folder in non-recursive fashion

    returns

    A Source of FtpFiles

  17. def ls(basePath: String, connectionSettings: (FtpApi.this)#S): Source[FtpFile, NotUsed]

    Scala API: creates a Source of FtpFiles from a base path.

    Scala API: creates a Source of FtpFiles from a base path.

    basePath

    Base path from which traverse the remote file server

    connectionSettings

    connection settings

    returns

    A Source of FtpFiles

  18. def ls(host: String, username: String, password: String, basePath: String): Source[FtpFile, NotUsed]

    Scala API: creates a Source of FtpFiles from a base path.

    Scala API: creates a Source of FtpFiles from a base path.

    host

    FTP, FTPs or SFTP host

    username

    username

    password

    password

    basePath

    Base path from which traverse the remote file server

    returns

    A Source of FtpFiles

  19. def ls(host: String, username: String, password: String): Source[FtpFile, NotUsed]

    Scala API: creates a Source of FtpFiles from the remote user root directory.

    Scala API: creates a Source of FtpFiles from the remote user root directory.

    host

    FTP, FTPs or SFTP host

    username

    username

    password

    password

    returns

    A Source of FtpFiles

  20. def ls(host: String, basePath: String): Source[FtpFile, NotUsed]

    Scala API: creates a Source of FtpFiles from a base path.

    Scala API: creates a Source of FtpFiles from a base path. By default, anonymous credentials will be used.

    host

    FTP, FTPs or SFTP host

    basePath

    Base path from which traverse the remote file server

    returns

    A Source of FtpFiles

  21. def ls(host: String): Source[FtpFile, NotUsed]

    Scala API: creates a Source of FtpFiles from the remote user root directory.

    Scala API: creates a Source of FtpFiles from the remote user root directory. By default, anonymous credentials will be used.

    host

    FTP, FTPs or SFTP host

    returns

    A Source of FtpFiles

  22. def mkdir(basePath: String, name: String, connectionSettings: (FtpApi.this)#S): Source[Done, NotUsed]

    Scala API for creating a directory in a given path

    Scala API for creating a directory in a given path

    basePath

    path to start with

    name

    name of a directory to create

    connectionSettings

    connection settings

    returns

    Source of akka.Done

  23. def mkdirAsync(basePath: String, name: String, connectionSettings: (FtpApi.this)#S)(implicit mat: Materializer): Future[Done]

    Scala API for creating a directory in a given path

    Scala API for creating a directory in a given path

    basePath

    path to start with

    name

    name of a directory to create

    connectionSettings

    connection settings

    returns

    Future of akka.Done indicating a materialized, asynchronous request

  24. def move(destinationPath: (FtpFile) ⇒ String, connectionSettings: (FtpApi.this)#S): Sink[FtpFile, Future[IOResult]]

    Scala API: creates a Sink of a FtpFile that moves a file to some file path.

    Scala API: creates a Sink of a FtpFile that moves a file to some file path.

    destinationPath

    a function that returns path to where the FtpFile is moved.

    connectionSettings

    connection settings

    returns

    A Sink of FtpFile that materializes to a Future of IOResult

  25. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  26. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  27. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  28. def remove(connectionSettings: (FtpApi.this)#S): Sink[FtpFile, Future[IOResult]]

    Scala API: creates a Sink of a FtpFile that removes a file.

    Scala API: creates a Sink of a FtpFile that removes a file.

    connectionSettings

    connection settings

    returns

    A Sink of FtpFile that materializes to a Future of IOResult

  29. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  30. def toPath(path: String, connectionSettings: (FtpApi.this)#S, append: Boolean = false): Sink[ByteString, Future[IOResult]]

    Scala API: creates a Sink of ByteString to some file path.

    Scala API: creates a Sink of ByteString to some file path.

    path

    the file path

    connectionSettings

    connection settings

    append

    append data if a file already exists, overwrite the file if not

    returns

    A Sink of ByteString that materializes to a Future of IOResult

  31. def toString(): String
    Definition Classes
    AnyRef → Any
  32. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  33. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  34. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @Deprecated @deprecated @throws( classOf[java.lang.Throwable] )
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

Inherited from AnyRef

Inherited from Any

Ungrouped