typed_struct 0.1.0-dev

  • README.md
  • Installing
  • Versions
  • 0

typed_struct #

Build Status Pub

Typed data structures in Dart. Loosely based on js-struct.

This package is in development and currently can be previewed using a mirrors-based implementation, and is not suitable for production use or use within a Flutter or Web binary. The end goal is seamless IPC-like communication for Isolates, binary data, and more.

Usage #

import 'package:struct/mirrors.dart';

abstract class SimpleStruct implements Struct {
  factory SimpleStruct() = _SimpleStructImpl;

  @int8
  int myChar;

  @int16
  int myShort;

  @int32
  int myInt;
}

class _SimpleStructImpl extends MirrorsStruct implements SimpleStruct {}

void main() {
  var struct = new SimpleStruct();
  simple.myChar = 'a'.codeUnitAt(0);
  simple.myShort = 12;
  simple.myInt = 34567;
}

How it works #

While the user interacts with a Struct using getters/setters, behind the scenes values are read and write to a ByteBuffer, a sequence of bytes in memory.

Read more about typed_arrays in the browser.

Use this package as a library

1. Depend on it

Add this to your package's pubspec.yaml file:


dependencies:
  typed_struct: ^0.1.0-dev

2. Install it

You can install packages from the command line:

with pub:


$ pub get

Alternatively, your editor might support pub get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:


import 'package:typed_struct/typed_struct.dart';
  
Version Uploaded Documentation Archive
0.1.0-dev Oct 8, 2016 Go to the documentation of typed_struct 0.1.0-dev Download typed_struct 0.1.0-dev archive
Popularity:
Describes how popular the package is relative to other packages. [more]
0
Health:
Code health derived from static analysis. [more]
--
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
--
Overall:
Weighted score of the above. [more]
0
Learn more about scoring.

The package version is not analyzed, because it does not support Dart 2. Until this is resolved, the package will receive a health and maintenance score of 0.

Analysis issues and suggestions

Support Dart 2 in pubspec.yaml.

The SDK constraint in pubspec.yaml doesn't allow the Dart 2.0.0 release. For information about upgrading it to be Dart 2 compatible, please see https://www.dartlang.org/dart-2#migration.

Maintenance issues and suggestions

Make sure dartdoc successfully runs on your package's source files. (-10 points)

Dependencies were not resolved.