pretty.core
Standard protocol to make it easier to nicely print a custom type in the REPL or elsewhere.
Standard protocol to make it easier to nicely print a custom type in the REPL or elsewhere.
PrettyPrintablecljprotocol
Implmement this protocol to return custom representations of objects when printing them. For best results, implement
this protocol in the class declaration form (i.e., as part of the defrecord/deftype/reify/etc. form) rather
than via extend-protocol or the like:
;; GOOD (defrecord MyRecordType [] PrettyPrintable (pretty [_] ...))
;; BAD (defrecord MyRecordType [])
(extend-protocol PrettyPrintable MyRecordType (pretty [_] ...))
Why? In the former example, MyRecordType actually implements the underlying pretty.core.PrettyPrintable
interface, in other words,
(instance? (Class/forName "pretty.core.PrettyPrintable") (->MyRecordType))
is true; this is not the case case when using extend-protocol and the like. The the prefer-method calls below
will have no effect on types that implement the protocol but not the underlying interface class itself.
Implmement this protocol to return custom representations of objects when printing them. For best results, implement
this protocol in the class declaration form (i.e., as part of the `defrecord`/`deftype`/`reify`/etc. form) rather
than via `extend-protocol` or the like:
;; GOOD
(defrecord MyRecordType []
PrettyPrintable
(pretty [_] ...))
;; BAD
(defrecord MyRecordType [])
(extend-protocol PrettyPrintable
MyRecordType
(pretty [_] ...))
Why? In the former example, `MyRecordType` actually implements the underlying `pretty.core.PrettyPrintable`
interface, in other words,
(instance? (Class/forName "pretty.core.PrettyPrintable") (->MyRecordType))
is true; this is not the case case when using `extend-protocol` and the like. The the `prefer-method` calls below
will have no effect on types that implement the protocol but not the underlying interface class itself.prettyclj
(pretty _)Return an appropriate representation of this object to be used when printing it, such as in the REPL or in log messages.
Return an appropriate representation of this object to be used when printing it, such as in the REPL or in log messages.
qualify-symbol-for-*ns*clj
(qualify-symbol-for-*ns* qualified-symb)Change the namespace of qualified-symb to an appropriate alias for *ns* if one exists, or remove it entirely
Change the namespace of `qualified-symb` to an appropriate alias for `*ns*` if one exists, or remove it entirely
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close