Package

ammonite

ops

Permalink

package ops

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ops
  2. RelPathStuff
  3. Extensions
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. sealed trait BasePath extends AnyRef

    Permalink

    A path which is either an absolute Path, a relative RelPath, or a ResourcePath with shared APIs and implementations.

    A path which is either an absolute Path, a relative RelPath, or a ResourcePath with shared APIs and implementations.

    Most of the filesystem-independent path-manipulation logic that lets you splice paths together or navigate in and out of paths lives in this interface

  2. trait BasePathImpl extends BasePath

    Permalink
  3. class Bytes extends AnyRef

    Permalink

    Trivial wrapper arround Array[Byte] with sane equality and useful toString

  4. class Callable1[T1, R] extends (T1) ⇒ R

    Permalink

    Provides a.! b as an alternative to the a(b) syntax for calling a function with one argument

  5. class Callable2[T1, T2, R] extends (T1, T2) ⇒ R

    Permalink

    Provides a! b as an alternative to the (a(b, _) syntax for partially applying a function with two arguments

  6. case class Command[T](cmd: Vector[String], envArgs: Map[String, String], execute: (Path, Command[_]) ⇒ T) extends Dynamic with Product with Serializable

    Permalink

    A staged sub-process command that has yet to be executed.

  7. case class CommandResult(exitCode: Int, chunks: Seq[Either[Bytes, Bytes]]) extends Product with Serializable

    Permalink

    Contains the accumulated output for the invocation of a subprocess command.

    Contains the accumulated output for the invocation of a subprocess command.

    Apart from the exit code, the primary data-structure is a sequence of byte chunks, tagged with Left for stdout and Right for stderr. This is interleaved roughly in the order it was emitted by the subprocess, and reflects what a user would have see if the subprocess was run manually.

    Derived from that, is the aggregate out and err StreamValues, wrapping stdout/stderr respectively, and providing convenient access to the aggregate output of each stream, as bytes or strings or lines.

  8. trait CopyMove extends (Path, Path) ⇒ Unit

    Permalink
  9. trait Extensions extends AnyRef

    Permalink
  10. sealed trait FilePath extends BasePath

    Permalink

    Represents a value that is either an absolute Path or a relative ResourcePath, and can be constructed from

  11. sealed trait FileType extends AnyRef

    Permalink

    Simple enum with the possible filesystem objects a path can resolve to

  12. class FilterMapExt[+T, Repr] extends AnyRef

    Permalink

    Extends collections to give short aliases for the commonly used operations, so we can make it easy to use from the command line.

  13. class FilterMapExt2[+T] extends AnyRef

    Permalink

    Extends collections to give short aliases for the commonly used operations, so we can make it easy to use from the command line.

  14. class FilterMapExtGen[+T] extends AnyRef

    Permalink

    Extends collections to give short aliases for the commonly used operations, so we can make it easy to use from the command line.

  15. trait ImplicitOp[V] extends (Path) ⇒ V

    Permalink
  16. case class InteractiveShelloutException() extends Exception with Product with Serializable

    Permalink
  17. case class LsSeq(base: Path, listed: RelPath*) extends Seq[Path] with Product with Serializable

    Permalink

    A specialized Seq[Path] used to provide better a better pretty-printed experience

  18. case class Path extends FilePath with BasePathImpl with Readable with Product with Serializable

    Permalink

    An absolute path on the filesystem.

    An absolute path on the filesystem. Note that the path is normalized and cannot contain any empty "", "." or ".." segments

  19. sealed trait PathFactory[PathType <: BasePath] extends (String) ⇒ PathType

    Permalink

    Enforces a standard interface for constructing BasePath-like things from java types of various sorts

  20. class PermSet extends Set[PosixFilePermission]

    Permalink

    A set of permissions

  21. class Pipeable[T] extends AnyRef

    Permalink

    Lets you pipe values through functions

  22. trait Readable extends AnyRef

    Permalink

    A path that can be read from, either a Path or a ResourcePath.

    A path that can be read from, either a Path or a ResourcePath. Encapsulates the logic of how to read from it in various ways.

  23. class RegexContext extends AnyRef

    Permalink

    Lets you pattern match strings with interpolated glob-variables

  24. case class RelPath extends FilePath with BasePathImpl with Product with Serializable

    Permalink

    An absolute path on the filesystem.

    An absolute path on the filesystem. Note that the path is normalized and cannot contain any empty or ".". Parent ".." segments can only occur at the left-end of the path, and are collapsed into a single number ups.

  25. implicit class RelPathStart extends AnyRef

    Permalink
    Definition Classes
    RelPathStuff
  26. implicit class RelPathStart2 extends AnyRef

    Permalink
    Definition Classes
    RelPathStuff
  27. trait RelPathStuff extends AnyRef

    Permalink
  28. case class ResourceNotFoundException(path: ResourcePath) extends Exception with Product with Serializable

    Permalink

    Thrown when you try to read from a resource that doesn't exist.

  29. case class ResourcePath extends BasePathImpl with Readable with Product with Serializable

    Permalink

    Classloaders are tricky: http://stackoverflow.com/questions/12292926

  30. sealed trait ResourceRoot extends AnyRef

    Permalink

    Represents a possible root where classpath resources can be loaded from; either a ResourceRoot.ClassLoader or a ResourceRoot.Class.

    Represents a possible root where classpath resources can be loaded from; either a ResourceRoot.ClassLoader or a ResourceRoot.Class. Resources loaded from classloaders are always loaded via their absolute path, while resources loaded via classes are always loaded relatively.

  31. case class Shellable(s: Seq[String]) extends Product with Serializable

    Permalink

    An implicit wrapper defining the things that can be "interpolated" directly into a subprocess call.

  32. case class ShelloutException(result: CommandResult) extends Exception with Product with Serializable

    Permalink

    Thrown when a shellout command results in a non-zero exit code.

    Thrown when a shellout command results in a non-zero exit code.

    Doesn't contain any additional information apart from the CommandResult that is normally returned, but ensures that failures in subprocesses happen loudly and won't get ignored unless intentionally caught

  33. case class StreamValue(chunks: Seq[Bytes]) extends Product with Serializable

    Permalink

    Encapsulates one of the output streams from a subprocess and provides convenience methods for accessing it in a variety of forms

  34. trait StreamableOp1[T1, R, C <: Seq[R]] extends (T1) ⇒ C

    Permalink

    An Callable1 that returns a Seq[R], but can also do so lazily (Iterator[R]) via op.iter! arg.

    An Callable1 that returns a Seq[R], but can also do so lazily (Iterator[R]) via op.iter! arg. You can then use the iterator however you wish

  35. implicit class iterShow[T] extends AnyRef

    Permalink
    Definition Classes
    Extensions
  36. case class kill(signal: Int)(implicit wd: Path) extends (Int) ⇒ CommandResult with Product with Serializable

    Permalink

    Kills the given process with the given signal, e.g.

    Kills the given process with the given signal, e.g. kill(9)! pid

  37. case class stat(name: String, size: Long, mtime: FileTime, owner: UserPrincipal, permissions: PermSet, fileType: FileType) extends Product with Serializable

    Permalink

    The result from doing an system stat on a particular path.

    The result from doing an system stat on a particular path.

    Created via stat! filePath.

    If you want more information, use stat.full

Value Members

  1. val %: Command[Unit]

    Permalink

    Used to spawn a subprocess interactively; any output gets printed to the console and any input gets requested from the current console.

    Used to spawn a subprocess interactively; any output gets printed to the console and any input gets requested from the current console. Can be used to run interactive subprocesses like %vim, %python, %ssh "www.google.com" or %sbt.

  2. val %%: Command[CommandResult]

    Permalink

    Spawns a subprocess non-interactively, waiting for it to complete and collecting all output into a CommandResult which exposes it in a convenient form.

    Spawns a subprocess non-interactively, waiting for it to complete and collecting all output into a CommandResult which exposes it in a convenient form. Call via %%('whoami).out.trim or %%('git, 'commit, "-am", "Hello!").exitCode

  3. object /

    Permalink

    Extractor to let you easily pattern match on ops.Paths.

    Extractor to let you easily pattern match on ops.Paths. Lets you do

    @ val base/segment/filename = pwd
    base: Path = Path(Vector("Users", "haoyi", "Dropbox (Personal)"))
    segment: String = "Workspace"
    filename: String = "Ammonite"

    To break apart a path and extract various pieces of it.

  4. object BasePath

    Permalink
  5. implicit def Callable1[T1, R](f: (T1) ⇒ R): Callable1[T1, R]

    Permalink
    Definition Classes
    Extensions
  6. implicit def Callable2[T1, T2, R](f: (T1, T2) ⇒ R): Callable2[T1, T2, R]

    Permalink
    Definition Classes
    Extensions
  7. implicit def ChainableConversions[T, T1, V](f: (T) ⇒ V)(implicit i: (T1) ⇒ T): (T1) ⇒ V

    Permalink
    Definition Classes
    Extensions
  8. object Extensions extends Extensions

    Permalink
  9. object FilePath extends PathFactory[FilePath]

    Permalink
  10. object FileType

    Permalink
  11. implicit def FilterMapArrays[T](a: Array[T]): FilterMapExt[T, Array[T]]

    Permalink

    Lets you call FilterMapExt aliases on Arrays too

    Lets you call FilterMapExt aliases on Arrays too

    Definition Classes
    Extensions
  12. implicit def FilterMapExt[T, Repr](i: TraversableLike[T, Repr]): FilterMapExt[T, Repr]

    Permalink
    Definition Classes
    Extensions
  13. implicit def FilterMapGenerators[T](a: Generator[T]): FilterMapExtGen[T]

    Permalink
    Definition Classes
    Extensions
  14. implicit def FilterMapIterators[T](a: Iterator[T]): FilterMapExt2[T]

    Permalink
    Definition Classes
    Extensions
  15. object ImplicitWd

    Permalink

    If you want to call subprocesses using % or %% and don't care what working directory they use, import this via

    If you want to call subprocesses using % or %% and don't care what working directory they use, import this via

    import ammonite.ops.ImplicitWd._

    To make them use the process's working directory for each subprocess

  16. object Internals

    Permalink
  17. object Path extends PathFactory[Path] with Serializable

    Permalink
  18. object PathError

    Permalink
  19. object PermSet

    Permalink
  20. implicit def Pipeable[T](t: T): Pipeable[T]

    Permalink
    Definition Classes
    Extensions
  21. object Readable

    Permalink
  22. object RegexContext

    Permalink
  23. implicit def RegexContextMaker(s: StringContext): RegexContext

    Permalink
    Definition Classes
    Extensions
  24. object RelPath extends RelPathStuff with PathFactory[RelPath] with Serializable

    Permalink
  25. object ResourcePath extends Serializable

    Permalink
  26. object ResourceRoot

    Permalink
  27. implicit def SeqFactoryFunc[T, CC[X] <: Seq[X] with GenericTraversableTemplate[X, CC]](s: SeqFactory[CC]): (Seq[T]) ⇒ CC[T]

    Permalink

    Allows you to pipe sequences into other sequences to convert them, e.g.

    Allows you to pipe sequences into other sequences to convert them, e.g. Seq(1, 2, 3) |> Vector

    Definition Classes
    Extensions
  28. object Shellable extends Serializable

    Permalink
  29. object Shellout

    Permalink

    Iternal utilities to support spawning subprocesses

  30. object cp extends (Path, Path) ⇒ Unit with CopyMove

    Permalink

    Copies a file or folder from one place to another.

    Copies a file or folder from one place to another. Creates any necessary directories, and copies folders recursively.

  31. val empty: RelPath

    Permalink
    Definition Classes
    RelPathStuff
  32. object exists extends (Path) ⇒ Boolean

    Permalink

    Checks if a file or folder exists at the given path.

  33. implicit def fileData(p: Path): full

    Permalink

    Lets you treat any path as a file, letting you access any property you'd normally access through stat-ing it by stat-ing the file for you when necessary.

  34. val home: Path

    Permalink

    The user's home directory

  35. object ln extends (Path, Path) ⇒ Unit

    Permalink

    Creates a hardlink between two paths.

    Creates a hardlink between two paths. Use .s(src, dest) to create a symlink

  36. object ls extends StreamableOp1[Path, Path, LsSeq] with ImplicitOp[LsSeq]

    Permalink

    List the files and folders in a directory.

    List the files and folders in a directory. Can be called with .iter to return an iterator, or .rec to recursively list everything in subdirectories. .rec is a ls.Walker which means that apart from straight-forwardly listing everything, you can pass in a skip predicate to cause your recursion to skip certain files or folders.

  37. object mkdir extends (Path) ⇒ Unit

    Permalink

    Makes directories up to the specified path.

    Makes directories up to the specified path. Equivalent to mkdir -p in bash

  38. object mv extends (Path, Path) ⇒ Unit with Mover with CopyMove

    Permalink

    Moves a file or folder from one place to another.

    Moves a file or folder from one place to another.

    Creates any necessary directories

  39. implicit val postfixOps: postfixOps

    Permalink
  40. lazy val pwd: Path

    Permalink

    The current working directory for this process.

  41. object read extends (Readable) ⇒ String

    Permalink

    Reads a file into memory, either as a String, as (read.lines(...): Seq[String]), or as (read.bytes(...): Array[Byte]).

  42. def resource(implicit resRoot: ResourceRoot = ...): ResourcePath

    Permalink
  43. object rm extends (Path) ⇒ Unit

    Permalink

    Roughly equivalent to bash's rm -rf.

    Roughly equivalent to bash's rm -rf. Deletes any files or folders in the target path, or does nothing if there aren't any

  44. val root: Path

    Permalink

    The root of the filesystem

  45. object stat extends (Path) ⇒ stat with Serializable

    Permalink
  46. object tmp

    Permalink

    Alias for java.nio.file.Files.createTempFile and java.io.File.deleteOnExit.

    Alias for java.nio.file.Files.createTempFile and java.io.File.deleteOnExit. Pass in deleteOnExit = false if you want the temp file to stick around.

  47. val up: RelPath

    Permalink
    Definition Classes
    RelPathStuff
  48. object write extends (Path, Writable) ⇒ Unit

    Permalink

    Write some data to a file.

    Write some data to a file. This can be a String, an Array[Byte], or a Seq[String] which is treated as consecutive lines. By default, this fails if a file already exists at the target location. Use write.over or write.append if you want to over-write it or add to what's already there.

Deprecated Value Members

  1. lazy val cwd: Path

    Permalink
    Annotations
    @deprecated
    Deprecated

    (Since version 0.7.5) replaced by pwd

Inherited from RelPathStuff

Inherited from Extensions

Inherited from AnyRef

Inherited from Any

Ungrouped