transit-clj
Transit is a data format and a set of libraries for conveying values between applications written in different languages. This library provides support for marshalling Transit data to/from Clojure.
This implementation's major.minor version number corresponds to the version of the Transit specification it supports.
NOTE: Transit is intended primarily as a wire protocol for transferring data between applications. If storing Transit data durably, readers and writers are expected to use the same version of Transit and you are responsible for migrating/transforming/re-storing that data when and if the transit format changes.
Releases and Dependency Information
- Latest release: 1.0.333
- All Released Versions
deps.edn dependency information:
com.cognitect/transit-clj {:mvn/version "1.0.333"}Maven dependency information:
<dependency>
<groupId>com.cognitect</groupId>
<artifactId>transit-clj</artifactId>
<version>1.0.333</version>
</dependency>Leiningen dependency information:
[com.cognitect/transit-clj "1.0.333"]Usage
(require '[cognitect.transit :as transit])
(import [java.io ByteArrayInputStream ByteArrayOutputStream])
;; Write data to a stream
(def out (ByteArrayOutputStream. 4096))
(def writer (transit/writer out :json))
(transit/write writer "foo")
(transit/write writer {:a [1 2]})
;; Take a peek at the JSON
(.toString out)
;; => "{\"~#'\":\"foo\"} [\"^ \",\"~:a\",[1,2]]"
;; Read data from a stream
(def in (ByteArrayInputStream. (.toByteArray out)))
(def reader (transit/reader in :json))
(prn (transit/read reader)) ;; => "foo"
(prn (transit/read reader)) ;; => {:a [1 2]}Default Type Mapping
| Transit type | Write accepts | Read returns |
|---|---|---|
| null | nil | nil |
| string | java.lang.String | java.lang.String |
| boolean | java.lang.Boolean | java.lang.Boolean |
| integer | java.lang.Byte, java.lang.Short, java.lang.Integer, java.lang.Long | java.lang.Long |
| decimal | java.lang.Float, java.lang.Double | java.lang.Double |
| keyword | clojure.lang.Keyword | clojure.lang.Keyword |
| symbol | clojure.lang.Symbol | clojure.lang.Symbol |
| big decimal | java.math.BigDecimal | java.math.BigDecimal |
| big integer | clojure.lang.BigInt,java.math.BigInteger | clojure.lang.BigInt |
| time | java.util.Date | java.util.Date |
| uri | java.net.URI, com.cognitect.transit.URI | com.cognitect.transit.URI |
| uuid | java.util.UUID | java.util.UUID |
| char | java.lang.Character | java.lang.Character |
| array | clojure.lang.IPersistentVector, java.util.List | clojure.lang.IPersistentVector |
| list | clojure.lang.ISeq | clojure.lang.ISeq |
| set | clojure.lang.IPersistentSet,java.util.Set | clojure.lang.IPersistentSet |
| map | clojure.lang.IPersistentMap,java.util.Map | clojure.lang.IPersistentMap |
| link | cognitect.transit.Link | cognitect.transit.Link |
| ratio + | clojure.lang.Ratio | clojure.lang.Ratio |
+ Extension using tagged values
Contributing
This library is open source, developed internally by Cognitect. We welcome discussions of potential problems and enhancement suggestions on the transit-format mailing list. Issues can be filed using GitHub issues for this project. Because transit is incorporated into products and client projects, we prefer to do development internally and are not accepting pull requests or patches.
Copyright and License
Copyright ยฉ 2014-2020 Cognitect
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
https://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.