fs - quasar.fs

Type Members

type ADir = Path[Abs, Dir, Sandboxed]
type AFile = Path[Abs, File, Sandboxed]
type APath = AbsPath[_]
type AbsPath[T] = Path[Abs, T, Sandboxed]
type DPath = DirPath[_]
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.
type DirPath[B] = Path[B, Dir, Sandboxed]
final case class ExecutionPlan(typ: FileSystemType, description: String) extends Product with Serializable
type FPath = FilePath[_]
type FilePath[B] = Path[B, File, Sandboxed]
type FileSystem[A] = Coproduct[QueryFile, FileSystem1, A]
type FileSystem0[A] = Coproduct[WriteFile, ManageFile, A]
type FileSystem1[A] = Coproduct[ReadFile, FileSystem0, A]
type FileSystemErrT[F[_], A] = EitherT[F, FileSystemError, A]
sealed trait FileSystemError extends AnyRef
type FileSystemFailure[A] = Failure[FileSystemError, A]
final case class FileSystemType(value: String) extends AnyVal with Product with Serializable
sealed trait ManageFile[A] extends AnyRef
sealed trait PathError extends AnyRef
type PathSegment = \/[DirName, FileName]
sealed trait QueryFile[A] extends AnyRef
type RDir = Path[Rel, Dir, Sandboxed]
type RFile = Path[Rel, File, Sandboxed]
type RPath = RelPath[_]
sealed trait ReadFile[A] extends AnyRef
type RelPath[T] = Path[Rel, T, Sandboxed]
final case class WriteError(value: Data, hint: Option[String]) extends Product with Serializable
sealed trait WriteFile[A] extends AnyRef

Value Members

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 PathError
object PathyCodecJson
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 WriteError extends Serializable
object WriteFile
object chroot
def firstSegmentName(f: RPath): Option[PathSegment]

Returns the first named segment of the given relative path.
def interpretFileSystem[M[_]](q: ~>[QueryFile, M], r: ~>[ReadFile, M], w: ~>[WriteFile, M], m: ~>[ManageFile, M]): ~>[FileSystem, M]
def mkAbsolute[T, S](baseDir: AbsDir[S], path: Path[_, T, S]): Path[Abs, T, S]
package mount
object mounted
def prettyPrint(path: Path[_, _, _]): String
def rebaseA(onto: ADir): ~>[AbsPath, AbsPath]

Rebases absolute paths onto the provided absolute directory, so rebaseA(/baz)(/foo/bar) becomes /baz/foo/bar.
def refineTypeAbs[T, S](path: Path[_, T, S]): \/[Path[Abs, T, S], Path[Rel, T, S]]
def sandboxAbs[T, S](apath: Path[Abs, T, S]): Path[Abs, T, Sandboxed]

Sandboxes an absolute path, needed due to parsing functions producing unsandboxed paths.
Sandboxes an absolute path, needed due to parsing functions producing unsandboxed paths.
TODO[pathy]: We know this can't fail, remove once Pathy is refactored to be more precise

Annotations
@SuppressWarnings()
def sandboxCurrent[A, T](path: Path[A, T, Unsandboxed]): Option[Path[A, T, Sandboxed]]
def stripPrefixA(prefix: ADir): ~>[AbsPath, AbsPath]

Removes the given prefix from an absolute path, if present.
object transformPaths

fs

package fs

Type Members

type ADir = Path[Abs, Dir, Sandboxed]

type AFile = Path[Abs, File, Sandboxed]

type APath = AbsPath[_]

type AbsPath[T] = Path[Abs, T, Sandboxed]

type DPath = DirPath[_]

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

type DirPath[B] = Path[B, Dir, Sandboxed]

final case class ExecutionPlan(typ: FileSystemType, description: String) extends Product with Serializable

type FPath = FilePath[_]

type FilePath[B] = Path[B, File, Sandboxed]

type FileSystem[A] = Coproduct[QueryFile, FileSystem1, A]

type FileSystem0[A] = Coproduct[WriteFile, ManageFile, A]

type FileSystem1[A] = Coproduct[ReadFile, FileSystem0, A]

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

sealed trait FileSystemError extends AnyRef

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

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

sealed trait ManageFile[A] extends AnyRef

sealed trait PathError extends AnyRef

type PathSegment = \/[DirName, FileName]

sealed trait QueryFile[A] extends AnyRef

type RDir = Path[Rel, Dir, Sandboxed]

type RFile = Path[Rel, File, Sandboxed]

type RPath = RelPath[_]

sealed trait ReadFile[A] extends AnyRef

type RelPath[T] = Path[Rel, T, Sandboxed]

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

sealed trait WriteFile[A] extends AnyRef

Value Members

object DataCursor

object Empty

object ExecutionPlan extends Serializable

object FileSystemError

object FileSystemType extends Serializable

object InMemory

object ManageFile

object PathError

object PathyCodecJson

object QueryFile

object ReadFile

object SandboxedPathy

object WriteError extends Serializable

object WriteFile

object chroot

def firstSegmentName(f: RPath): Option[PathSegment]

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

def mkAbsolute[T, S](baseDir: AbsDir[S], path: Path[_, T, S]): Path[Abs, T, S]

package mount

object mounted

def prettyPrint(path: Path[_, _, _]): String

def rebaseA(onto: ADir): ~>[AbsPath, AbsPath]

def refineTypeAbs[T, S](path: Path[_, T, S]): \/[Path[Abs, T, S], Path[Rel, T, S]]

def sandboxAbs[T, S](apath: Path[Abs, T, S]): Path[Abs, T, Sandboxed]

def sandboxCurrent[A, T](path: Path[A, T, Unsandboxed]): Option[Path[A, T, Sandboxed]]

def stripPrefixA(prefix: ADir): ~>[AbsPath, AbsPath]

object transformPaths

Inherited from AnyRef

Inherited from Any

Ungrouped