Packages

sealed trait PosixFiles[F[_]] extends UnsealedReadFiles[F]

Enables interacting with the file system in a way modeled on Node.js fs module which in turn is modeled on standard POSIX functions.

Source
PosixFiles.scala
See also

https://nodejs.org/api/fs.html

Linear Supertypes
UnsealedReadFiles[F], ReadFiles[F], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. PosixFiles
  2. UnsealedReadFiles
  3. ReadFiles
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def access(path: Path, mode: AccessMode = AccessMode.F_OK): F[Boolean]
  2. abstract def chmod(path: Path, mode: FileAccessMode): F[Unit]
  3. abstract def chown(path: Path, uid: Long, guid: Long): F[Unit]
  4. abstract def copyFile(src: Path, dest: Path, mode: CopyMode = CopyMode.Default): F[Unit]
  5. abstract def lchown(path: Path, uid: Long, guid: Long): F[Unit]
  6. abstract def link(existingPath: Path, newPath: Path): F[Unit]
  7. abstract def lstat(path: Path): F[Stats]
  8. abstract def mkdir(path: Path, recursive: Boolean = false, mode: FileAccessMode = FileAccessMode.Default): F[Path]
  9. abstract def mkdtemp(path: Path = Path.tmpdir, prefix: String = ""): Resource[F, Path]
  10. abstract def open(path: Path, flags: Flags = Flags.r, mode: FileAccessMode = FileAccessMode.OpenDefault): Resource[F, FileHandle[F]]
  11. abstract def opendir(path: Path): Stream[F, Path]
  12. abstract def readAll(path: Path, flags: Flags = Flags.r): Stream[F, Byte]
  13. abstract def readAll(path: Path, chunkSize: Int): Stream[F, Byte]

    Reads all data from the file at the specified path.

    Reads all data from the file at the specified path.

    Definition Classes
    ReadFiles
  14. abstract def readCursor(path: Path, flags: Flags = Flags.r): Resource[F, ReadCursor[F]]
  15. abstract def readCursor(path: Path): Resource[F, ReadCursor[F]]

    Returns a ReadCursor for the specified path.

    Returns a ReadCursor for the specified path.

    Definition Classes
    ReadFiles
  16. abstract def readRange(path: Path, chunkSize: Int, start: Long, end: Long): Stream[F, Byte]

    Reads a range of data synchronously from the file at the specified path.

    Reads a range of data synchronously from the file at the specified path. start is inclusive, end is exclusive, so when start is 0 and end is 2, two bytes are read.

    Definition Classes
    ReadFiles
  17. abstract def readlink(path: Path): F[Path]
  18. abstract def realpath(path: Path): F[Path]
  19. abstract def rename(oldPath: Path, newPath: Path): F[Unit]
  20. abstract def rm(path: Path, force: Boolean = false, maxRetries: Int = 0, recursive: Boolean = false, retryDelay: FiniteDuration = 100.milliseconds): F[Unit]
  21. abstract def rmdir(path: Path, maxRetries: Int = 0, retryDelay: FiniteDuration = 100.milliseconds): F[Unit]
  22. abstract def stat(path: Path): F[Stats]
  23. abstract def tail(path: Path, chunkSize: Int, offset: Long = 0L, pollDelay: FiniteDuration): Stream[F, Byte]

    Returns an infinite stream of data from the file at the specified path.

    Returns an infinite stream of data from the file at the specified path. Starts reading from the specified offset and upon reaching the end of the file, polls every pollDuration for additional updates to the file.

    Read operations are limited to emitting chunks of the specified chunk size but smaller chunks may occur.

    If an error occurs while reading from the file, the overall stream fails.

    Definition Classes
    ReadFiles
  24. abstract def unlink(path: Path): F[Unit]
  25. abstract def walk(path: Path, maxDepth: Int = Int.MaxValue): Stream[F, Path]
  26. abstract def writeAll(path: Path, flags: Flags = Flags.w, mode: FileAccessMode = FileAccessMode.OpenDefault): Pipe[F, Byte, INothing]
  27. abstract def writeCursor(path: Path, flags: Flags = Flags.w, mode: FileAccessMode = FileAccessMode.OpenDefault): Resource[F, WriteCursor[F]]
  28. abstract def writeCursorFromFileHandle(file: FileHandle[F], append: Boolean): F[WriteCursor[F]]
  29. abstract def writeRotate(computePath: F[Path], limit: Long, flags: Flags = Flags.w, mode: FileAccessMode = FileAccessMode.OpenDefault): Pipe[F, Byte, INothing]

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[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  14. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  15. def toString(): String
    Definition Classes
    AnyRef → Any
  16. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  17. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  18. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

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

Inherited from UnsealedReadFiles[F]

Inherited from ReadFiles[F]

Inherited from AnyRef

Inherited from Any

Ungrouped