Skip to content

Latest commit

 

History

History
111 lines (83 loc) · 4.36 KB

README.md

File metadata and controls

111 lines (83 loc) · 4.36 KB
Raw

transit-dart

Transit is a data format and set of libraries for conveying values between applications written in different languages. This library provides support for marshalling Transit data to/from Dart.

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: 0.8.90

Getting started

dart pub add transit_dart

Then in your Dart code, you can use:

import 'package:transit_dart/transit_dart.dart';

See Installing.

Usage

See Example

Default Type Mapping

Transit Type Write accepts Read produces
null null null
string String String
boolean bool bool
integer int int
decimal double double
bytes Uint8List Uint8List
keyword transit_dart.Keyword transit_dart.Keyword
symbol transit_dart.Symbol transit_dart.Symbol
big decimal transit_dart.BigDecimal (wraps big_decimal/BigDecimal) transit_dart.BigDecimal (wraps big_decimal/BigDecimal)
big integer BigInt BigInt
time DateTime DateTime
uuid transit_dart.Uuid transit_dart.Uuid
uri transit_dart.TransitUri transit_dart.TransitUri
char String String
special numbers double.nan, double.infinity, double.negativeInfinity double.nan, double.infinity, double.negativeInfinity
array List List
map Map Map
set Set Set
list transit_dart.TransitList transit_dart.TransitList
link transit_dart.Link transit_dart.Link

Testing

To run the roundtrip verification tests in transit-format, first ensure Dart>=2.19.1 and Java 8 are installed, then do the following:

  1. Set up a testing directory where transit-format and transit-dart can be cloned side-by-side. We have a fork of transit-format that has support for testing transit-dart all ready to go. Clone this to your test folder.
mkdir transit-test
cd transit-test
git clone https://github.com/wevre/transit-format.git
# Do something similar to the following to ensure Java 8.
jenv local 1.8
  1. From the transit-format folder, run the verify command.
bin/verify -impls dart

Additional information

Coming soon, more info about the package: where to find more information, how to contribute to the package, how to file issues, what response they can expect from the package authors, and more.

Copyright and License

Copyright © 2023 Michael J. Weaver

This library is a Dart port of the Java version created and maintained by Cognitect.

Copyright © 2014 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.