Liking cljdoc? Tell your friends :D

rp.jackdaw.serdes.homogeneous-edn

Implements an EDN SerDe (Serializer/Deserializer). While the native jackdaw EDN SerDe fulfills most purposes, in order for the RentPath Kafka Connect EdnConverter (https://search.maven.org/artifact/com.rentpath/kafka-connect-converters/0.1.1/jar) to infer the requisite schema from the data itself, said data must conform to a series of further rules above and beyond those normally associated with the EDN specification; namely, that all compound data structures be consistent, their elements homogeneous in both type and structure. This SerDe exists to provide an (optional) means of validating these additional requirements, so as to ensure that no data from which a schema may not be autoderived (and thus unable to be sunk) is produced to any Kafka topic that is intended for Kafka Connect sinking.

Implements an EDN SerDe (Serializer/Deserializer). While the native jackdaw EDN SerDe fulfills
most purposes, in order for the RentPath Kafka Connect EdnConverter
(https://search.maven.org/artifact/com.rentpath/kafka-connect-converters/0.1.1/jar) to infer
the requisite schema from the data itself, said data must conform to a series of further rules
above and beyond those normally associated with the EDN specification; namely, that all compound
data structures be consistent, their elements homogeneous in both type and structure. This SerDe
exists to provide an (optional) means of validating these additional requirements, so as to ensure
that no data from which a schema may not be autoderived (and thus unable to be sunk) is produced
to any Kafka topic that is intended for Kafka Connect sinking.
raw docstring

bytearray-typeclj

source

compact-protocolclj

This defines an extension of the default bpsm EDN lib printer to permit printing of native clojure data structures, which it normally has no concept of.

This defines an extension of the default bpsm EDN lib printer to permit printing of native clojure
data structures, which it normally has no concept of.
sourceraw docstring

conform!clj

(conform! data {:keys [validate?] :as opts})

Conforms the provided data structure according to the passed options.

If the validate? option is set to true, validates the input as homogeneous in all respects save structs, recursively homogenizing that latter, returning the resulting conformed data structure. Will throw an exception if not valid and conformable in this case.

If the canonicalize? option is set to true, will enforce Comparable-type ordering on all map and struct keys as well as set elements. If it encounters data using complex keys and/or elements, those will be returned as-is and a warning logged.

Conforms the provided data structure according to the passed options.

If the validate? option is set to true, validates the input as homogeneous in all respects save
structs, recursively homogenizing that latter, returning the resulting conformed data structure.
Will throw an exception if not valid and conformable in this case.

If the canonicalize? option is set to true, will enforce Comparable-type ordering on all map and
struct keys as well as set elements. If it encounters data using complex keys and/or elements,
those will be returned as-is and a warning logged.
sourceraw docstring

EdnSerde-configureclj

source

EdnSerde-deserializerclj

(EdnSerde-deserializer & _)
source

EdnSerde-serializerclj

(EdnSerde-serializer & _)
source

list-printerclj

source

serdeclj

(serde & [opts])

Returns an optionally-homogeneous EDN serde.

Returns an optionally-homogeneous EDN serde.
sourceraw docstring

serialize*clj

(serialize* data {:keys [compact?] :as opts})

Converts the provided data structure to EDN. If the compact? option is specified, will use the bpsm java EDN compact serialization rather than the native clojure prn-str fn.

Converts the provided data structure to EDN. If the compact? option is specified, will use the
bpsm java EDN compact serialization rather than the native clojure prn-str fn.
sourceraw docstring

serializerclj

(serializer)
(serializer opts)

Returns an EDN serializer. If the :validate? option is set, the data to be written will first be validated as and conformed to the homogeneous EDN spec. Will throw an exception if not valid and conformable.

Returns an EDN serializer. If the `:validate?` option is set, the data to be written will first
be validated as and conformed to the homogeneous EDN spec. Will throw an exception if not valid
and conformable.
sourceraw docstring

set-printerclj

source

valid?clj

(valid? data & [schema])

Will return true if the input data structure conforms to the homogeneous EDN requirements. May be provided with an optional previously-compiled schema structure to prevent recompilation.

Will return true if the input data structure conforms to the homogeneous EDN requirements. May
be provided with an optional previously-compiled schema structure to prevent recompilation.
sourceraw docstring

vec-printerclj

source

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close