A CBOR library for Dart developers.
This package provides an encoding/decoding package for the Concise Binary Object Representation as documented in RFC7049.
CBOR is increasingly used as a line protocol in the IOT world where the overhead of transmitting JSON on constrained devices can be large in packet size and processing overheads.
The Cbor package provides an RFC7049 compliant solution for both the encoding and decoding of CBOR data.
The test suite supports the encoding and decoding examples in Appendix A of RFC7049 amongst others. Specifically :-
The implementation of maps restricts map keys to be of either string or integer type, note this is an extension to the RFC which suggests that only string keys be supported.
Please examine the files in the examples directory for usage examples and the API docs for greater detail.
In general the package guarantees to decode what it encodes and should decode all well formed CBOR data. Decoded output takes the form of standard Dart types, i.e. floats become doubles, text become String, arrays become Lists etc. This allows a simple interface for encoding from the Dart world and a simple interface to Dart world from the decoder.
Currently the package supports a payload based decoding, i.e. a complete CBOR entity needs to be submitted to the decoder. Streamed decoding may be supported in future versions. Also error handling is somewhat basic, very badly formed CBOR data may trigger exceptions in the decoding process, if you need to protect against this please enclose all decoding operations in try/catch blocks. If you use this package at both ends of your CBOR interchange nodes you will not need to do this.
Add this to your package's pubspec.yaml file:
dependencies: cbor: "^1.0.0"
You can install packages from the command line:
$ pub get
$ flutter packages get
Alternatively, your editor might support
pub get or
Check the docs for your editor to learn more.
Now in your Dart code, you can use:
|1.0.4||Feb 16, 2018|
|1.0.3||Dec 11, 2017|
|1.0.2||Jul 14, 2017|
|1.0.1||May 4, 2017|
|1.0.0||Apr 11, 2017|
We analyzed this package on Apr 24, 2018, and provided a score, details, and suggestions below. Analysis was completed with status completed using:
Describes how popular the package is relative to other packages. [more]
Code health derived from static analysis. [more]
Reflects how tidy and up-to-date the package is. [more]
Weighted score of the above. [more]
Detected platforms: Flutter, web, other
No platform restriction found in primary library
Use constrained dependencies.
pubspec.yamlcontains 2 dependencies without version constraints. Specify version ranges for the following dependencies:
Fix analysis and formatting issues.
Analysis or formatting checks reported 1 error 7 hints.
Strong-mode analysis of
lib/src/cbor_item_stack.dartfailed with the following error:
line: 21 col: 27
Couldn't infer type parameter 'E'.\n\nTried to infer 'LinkedListEntry<dynamic>' for 'E' which doesn't work:\n Type parameter 'E' declared to extend 'LinkedListEntry<LinkedListEntry<dynamic>>'.\nThe type 'LinkedListEntry<dynamic>' was inferred from:\n Return type declared as 'LinkedList<E>'\n used where 'LinkedList<LinkedListEntry<dynamic>>' is required.\n\nConsider passing explicit type argument(s) to the generic.\n\n
Similar analysis of the following files failed:
The description is too short.
Add more detail about the package, what it does and what is its target use case. Try to write at least 60 characters.
Maintain an example.
None of the files in your
example/directory matches a known example patterns. Common file name patterns include:
example.dartor you could also use
|Dart SDK||>=1.0.0 <2.0.0|