fs - quasar.fs

Type Members

sealed abstract class Analyze[A] extends AnyRef
type BackendEffect[A] = Coproduct[Analyze, FileSystem, A]
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.
final case class ExecutionPlan(typ: FileSystemType, physicalPlan: slamdata.Predef.String, inputs: ISet[APath]) extends Product with Serializable
type FileSystem[A] = Coproduct[QueryFile, [A]Coproduct[ReadFile, [A]Coproduct[WriteFile, ManageFile, A], A], A]
type FileSystemErrT[F[_], A] = EitherT[F, FileSystemError, A]
sealed abstract class FileSystemError extends AnyRef
type FileSystemFailure[A] = Failure[FileSystemError, A]
final case class FileSystemType(value: slamdata.Predef.String) extends AnyVal with Product with Serializable
sealed abstract class ManageFile[A] extends AnyRef
type MonadFsErr[F[_]] = MonadError_[F, FileSystemError]
type PhysErr[A] = Failure[PhysicalError, A]
sealed abstract class PhysicalError extends AnyRef

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.
abstract class PhysicalErrorPrisms extends AnyRef
sealed abstract class QueryFile[A] extends AnyRef
sealed abstract class ReadFile[A] extends AnyRef
final case class UnhandledFSError(cause: Exception) extends PhysicalError with Product with Serializable
final case class WriteError(value: Data, hint: slamdata.Predef.Option[slamdata.Predef.String]) extends Product with Serializable
sealed abstract class WriteFile[A] extends AnyRef

Value Members

object Analyze
object DataCursor
object Empty

FileSystem interpreters for a filesystem that has no, and doesn't support creating any, files.
object ExecutionPlan extends Serializable
object FileSystemError
object FileSystemType extends Serializable
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.
object ManageFile
object MonadFsErr
object PhysicalError extends PhysicalErrorPrisms
object QueryFile
object ReadFile
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.
object UnhandledFSError extends Serializable
object WriteError extends Serializable
object WriteFile
object chroot
object impl
def interpretBackendEffect[M[_]](a: ~>[Analyze, M], q: ~>[QueryFile, M], r: ~>[ReadFile, M], w: ~>[WriteFile, M], m: ~>[ManageFile, M]): ~>[BackendEffect, M]
def interpretFileSystem[M[_]](q: ~>[QueryFile, M], r: ~>[ReadFile, M], w: ~>[WriteFile, M], m: ~>[ManageFile, M]): ~>[FileSystem, M]
package mount
object mounted
object transformPaths
val unhandledFSError: Prism[PhysicalError, Exception]

Definition Classes
PhysicalErrorPrisms

fs

package fs

Type Members

sealed abstract class Analyze[A] extends AnyRef

type BackendEffect[A] = Coproduct[Analyze, FileSystem, A]

trait DataCursor[F[_], C] extends AnyRef

final case class ExecutionPlan(typ: FileSystemType, physicalPlan: slamdata.Predef.String, inputs: ISet[APath]) extends Product with Serializable

type FileSystem[A] = Coproduct[QueryFile, [A]Coproduct[ReadFile, [A]Coproduct[WriteFile, ManageFile, A], A], A]

type FileSystemErrT[F[_], A] = EitherT[F, FileSystemError, A]

sealed abstract class FileSystemError extends AnyRef

type FileSystemFailure[A] = Failure[FileSystemError, A]

final case class FileSystemType(value: slamdata.Predef.String) extends AnyVal with Product with Serializable

sealed abstract class ManageFile[A] extends AnyRef

type MonadFsErr[F[_]] = MonadError_[F, FileSystemError]

type PhysErr[A] = Failure[PhysicalError, A]

sealed abstract class PhysicalError extends AnyRef

abstract class PhysicalErrorPrisms extends AnyRef

sealed abstract class QueryFile[A] extends AnyRef

sealed abstract class ReadFile[A] extends AnyRef

final case class UnhandledFSError(cause: Exception) extends PhysicalError with Product with Serializable

final case class WriteError(value: Data, hint: slamdata.Predef.Option[slamdata.Predef.String]) extends Product with Serializable

sealed abstract class WriteFile[A] extends AnyRef

Value Members

object Analyze

object DataCursor

object Empty

object ExecutionPlan extends Serializable

object FileSystemError

object FileSystemType extends Serializable

object InMemory

object ManageFile

object MonadFsErr

object PhysicalError extends PhysicalErrorPrisms

object QueryFile

object ReadFile

object SandboxedPathy

object UnhandledFSError extends Serializable

object WriteError extends Serializable

object WriteFile

object chroot

object impl

def interpretBackendEffect[M[_]](a: ~>[Analyze, M], q: ~>[QueryFile, M], r: ~>[ReadFile, M], w: ~>[WriteFile, M], m: ~>[ManageFile, M]): ~>[BackendEffect, M]

def interpretFileSystem[M[_]](q: ~>[QueryFile, M], r: ~>[ReadFile, M], w: ~>[WriteFile, M], m: ~>[ManageFile, M]): ~>[FileSystem, M]

package mount

object mounted

object transformPaths

val unhandledFSError: Prism[PhysicalError, Exception]

Inherited from PhysicalErrorPrisms

Inherited from AnyRef

Inherited from Any

Ungrouped