sealed trait FtpApi[FtpClient, S <: RemoteFileSettings] extends AnyRef
- Self Type
- FtpApi[FtpClient, S] with FtpSourceFactory[FtpClient, S]
- Annotations
- @DoNotInherit()
- Source
- FtpApi.scala
- Alphabetic
- By Inheritance
- FtpApi
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Abstract Value Members
- abstract def fromPath(path: String, connectionSettings: 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
- abstract def fromPath(path: String, connectionSettings: 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
- abstract 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
- abstract 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
- abstract def ls(basePath: String, connectionSettings: S, branchSelector: (FtpFile) => Boolean, emitTraversedDirectories: Boolean): Source[FtpFile, NotUsed]
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
- abstract def ls(basePath: String, connectionSettings: S, branchSelector: (FtpFile) => Boolean): Source[FtpFile, NotUsed]
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
- abstract def ls(basePath: String, connectionSettings: S): Source[FtpFile, NotUsed]
- abstract def ls(host: String, username: String, password: String, basePath: String): Source[FtpFile, NotUsed]
- abstract def ls(host: String, username: String, password: String): Source[FtpFile, NotUsed]
Scala API: creates a Source of FtpFiles from the remote user
rootdirectory. - abstract def ls(host: String, basePath: String): Source[FtpFile, NotUsed]
- abstract def ls(host: String): Source[FtpFile, NotUsed]
Scala API: creates a Source of FtpFiles from the remote user
rootdirectory. - abstract def mkdir(basePath: String, name: String, connectionSettings: 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 pekko.Done
- abstract def mkdirAsync(basePath: String, name: String, connectionSettings: S)(implicit system: ClassicActorSystemProvider): 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 pekko.Done indicating a materialized, asynchronous request
- abstract def move(destinationPath: (FtpFile) => String, connectionSettings: S): Sink[FtpFile, Future[IOResult]]
Scala API: creates a Sink of a FtpFile that moves a file to some file path.
- abstract def remove(connectionSettings: S): Sink[FtpFile, Future[IOResult]]
- abstract def toPath(path: String, connectionSettings: 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
Concrete Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()