fs2-ftp
API
Generated with
fs2-ftp/fs2.ftp

fs2.ftp

package fs2.ftp

Members list

Type members

Classlikes

final case class ConnectionError(message: String, cause: Throwable) extends IOException

Represent a connection failure to a FTP/SFTP servers

Represent a connection failure to a FTP/SFTP servers

Attributes

Companion
object
Supertypes
trait Product
trait Equals
class IOException
class Exception
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Show all
object ConnectionError

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class FileTransferIncompleteError(message: String) extends IOException

Attributes

Supertypes
trait Product
trait Equals
class IOException
class Exception
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Show all
trait FtpClient[F[_], +A]

Base trait of FtpClient which expose only safe methods F[_] represents the effect type will be use A underlying ftp client instance type

Base trait of FtpClient which expose only safe methods F[_] represents the effect type will be use A underlying ftp client instance type

Attributes

Supertypes
class Object
trait Matchable
class Any
final case class FtpResource(path: String, size: Long, lastModified: Long, permissions: Set[PosixFilePermission], isDirectory: Option[Boolean])

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object FtpResource

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
sealed trait FtpSettings[A]

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object FtpSettings

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class InvalidPathError(message: String) extends IOException

Attributes

Supertypes
trait Product
trait Equals
class IOException
class Exception
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Show all
object SecureFtp

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
SecureFtp.type
object UnsecureFtp

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type

Value members

Concrete methods

def connect[F[_] : Async, A](settings: FtpSettings[A]): Resource[F, FtpClient[F, A]]

Create a safe FTP/SFTP client resource Required to provide a ContextShift, since all operation will be executed into a dedicated thread pool

Create a safe FTP/SFTP client resource Required to provide a ContextShift, since all operation will be executed into a dedicated thread pool

If operation failed, it emit a fs2.ftp.ConnectionError with the cause of the failure

Attributes

Generated with