API for clojure.repl - Clojure v1.6 (stable)

by Chris Houser, Christophe Grand, Stephen Gilardi, Michel Salim

Full namespace name: clojure.repl

Overview

Utilities meant to be used interactively at the REPL

Public Variables and Functions



apropos

function
Usage: (apropos str-or-pattern)
Given a regular expression or stringable thing, return a seq of
all definitions in all currently-loaded namespaces that match the
str-or-pattern.
Source


demunge

function
Usage: (demunge fn-name)
Given a string representation of a fn class,
as in a stack trace element, returns a readable version.
Added in Clojure version 1.3
Source


dir

macro
Usage: (dir nsname)
Prints a sorted directory of public vars in a namespace
Source


dir-fn

function
Usage: (dir-fn ns)
Returns a sorted seq of symbols naming public vars in
a namespace
Source


doc

macro
Usage: (doc name)
Prints documentation for a var or special form given its name
Added in Clojure version 1.0
Source


find-doc

function
Usage: (find-doc re-string-or-pattern)
Prints documentation for any var whose documentation or name
contains a match for re-string-or-pattern
Added in Clojure version 1.0
Source


pst

function
Usage: (pst)
       (pst e-or-depth)
       (pst e depth)
Prints a stack trace of the exception, to the depth requested. If none supplied, uses the root cause of the
most recent repl exception (*e), and a depth of 12.
Added in Clojure version 1.3
Source


root-cause

function
Usage: (root-cause t)
Returns the initial cause of an exception or error by peeling off all of
its wrappers
Added in Clojure version 1.3
Source


set-break-handler!

function
Usage: (set-break-handler!)
       (set-break-handler! f)
Register INT signal handler.  After calling this, Ctrl-C will cause
the given function f to be called with a single argument, the signal.
Uses thread-stopper if no function given.
Source


source

macro
Usage: (source n)
Prints the source code for the given symbol, if it can find it.
This requires that the symbol resolve to a Var defined in a
namespace for which the .clj is in the classpath.

Example: (source filter)
Source


source-fn

function
Usage: (source-fn x)
Returns a string of the source code for the given symbol, if it can
find it.  This requires that the symbol resolve to a Var defined in
a namespace for which the .clj is in the classpath.  Returns nil if
it can't find the source.  For most REPL usage, 'source' is more
convenient.

Example: (source-fn 'filter)
Source


stack-element-str

function
Usage: (stack-element-str el)
Returns a (possibly unmunged) string representation of a StackTraceElement
Added in Clojure version 1.3
Source


thread-stopper

function
Usage: (thread-stopper)
       (thread-stopper thread)
Returns a function that takes one arg and uses that as an exception message
to stop the given thread.  Defaults to the current thread
Source
Logo & site design by Tom Hickey.
Clojure auto-documentation system by Tom Faulhaber.