Packages

package fs

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. fs
  2. PhysicalErrorPrisms
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. sealed abstract class Analyze[A] extends AnyRef
  2. type BackendEffect[A] = Coproduct[Analyze, FileSystem, A]
  3. trait DataCursor[F[_], C] extends AnyRef

    Typeclass representing the interface to a effectful cursor of Data.

    Typeclass representing the interface to a effectful cursor of Data.

    Laws

    1. close(c) *> nextChunk(c) must return an empty Vector.
  4. sealed trait DirNode extends Node
  5. final case class ExecutionPlan(typ: FileSystemType, physicalPlan: slamdata.Predef.String, inputs: ISet[APath]) extends Product with Serializable
  6. sealed trait FileNode extends Node
  7. type FileSystem[A] = Coproduct[QueryFile, [A]Coproduct[ReadFile, [A]Coproduct[WriteFile, ManageFile, A], A], A]
  8. type FileSystemErrT[F[_], A] = EitherT[F, FileSystemError, A]
  9. sealed abstract class FileSystemError extends QuasarError
  10. type FileSystemFailure[A] = Failure[FileSystemError, A]
  11. final case class FileSystemType(value: slamdata.Predef.String) extends AnyVal with Product with Serializable
  12. sealed abstract class ManageFile[A] extends AnyRef
  13. type MonadFsErr[F[_]] = MonadError_[F, FileSystemError]
  14. sealed trait Node extends AnyRef
  15. type PhysErr[A] = Failure[PhysicalError, A]
  16. sealed abstract class PhysicalError extends QuasarError

    A runtime error encountered within a data source connector.

    A runtime error encountered within a data source connector. A user isn't expected to usually be able to handle these as they likely arise from a defect or an "environmental" issue (memory, network, storage, etc).

    This should not be used to communicate configuration/validation errors at mount-time as DefinitionError is more appropriate in that case.

  17. abstract class PhysicalErrorPrisms extends AnyRef
  18. sealed abstract class QueryFile[A] extends AnyRef
  19. sealed abstract class ReadFile[A] extends AnyRef
  20. final case class UnhandledFSError(cause: Exception) extends PhysicalError with Product with Serializable
  21. final case class WriteError(value: Data, hint: slamdata.Predef.Option[slamdata.Predef.String]) extends Product with Serializable
  22. sealed abstract class WriteFile[A] extends AnyRef

Value Members

  1. def interpretBackendEffect[M[_]](a: ~>[Analyze, M], q: ~>[QueryFile, M], r: ~>[ReadFile, M], w: ~>[WriteFile, M], m: ~>[ManageFile, M]): ~>[BackendEffect, M]
  2. def interpretFileSystem[M[_]](q: ~>[QueryFile, M], r: ~>[ReadFile, M], w: ~>[WriteFile, M], m: ~>[ManageFile, M]): ~>[FileSystem, M]
  3. val unhandledFSError: Prism[PhysicalError, Exception]
    Definition Classes
    PhysicalErrorPrisms
  4. object Analyze
  5. object DataCursor
  6. object Empty

    FileSystem interpreters for a filesystem that has no, and doesn't support creating any, files.

  7. object ExecutionPlan extends Serializable
  8. object FileSystemError
  9. object FileSystemType extends Serializable
  10. object InMemory

    In-Memory FileSystem interpreters, useful for testing/stubbing when a "real" interpreter isn't needed or desired.

    In-Memory FileSystem interpreters, useful for testing/stubbing when a "real" interpreter isn't needed or desired.

    NB: Since this is in-memory, careful with writing large amounts of data to the file system.

  11. object ManageFile
  12. object MonadFsErr
  13. object Node
  14. object PhysicalError extends PhysicalErrorPrisms
  15. object QueryFile
  16. object ReadFile
  17. object SandboxedPathy

    Use with care.

    Use with care. Functions make the assumption that Sandboxed Pathy paths do not contain ParentIn or Current. This can not currently be guaranteed.

  18. object UnhandledFSError extends Serializable
  19. object WriteError extends Serializable
  20. object WriteFile
  21. object chroot
  22. object impl
  23. object mounted
  24. object transformPaths

Inherited from PhysicalErrorPrisms

Inherited from AnyRef

Inherited from Any

Ungrouped