typed_struct 0.1.0-dev

  • README.md
  • Installing
  • Versions
  • 30

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

with Flutter:


$ flutter packages get

Alternatively, your editor might support pub get or flutter packages 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]
100
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
0
Overall:
Weighted score of the above. [more]
30
Learn more about scoring.

We analyzed this package on Oct 10, 2018, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.0.0
  • pana: 0.12.4

Platforms

Detected platforms: Flutter, web, other

No platform restriction found in primary library package:typed_struct/typed_struct.dart.

Maintenance issues and suggestions

Package is too old. (-100 points)

The package was released more than two years ago.

Maintain CHANGELOG.md. (-20 points)

Changelog entries help clients to follow the progress in your code.

Add SDK constraint in pubspec.yaml. (-5 points)

For information about setting SDK constraint, please see https://www.dartlang.org/tools/pub/pubspec#sdk-constraints.

The description is too short. (-20 points)

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. (-10 points)

Create a short demo in the example/ directory to show how to use this package. Common file name patterns include: main.dart, example.dart or you could also use typed_struct.dart.

Package is pre-release. (-5 points)

Pre-release versions should be used with caution, their API may change in breaking ways.

Dependencies

Package Constraint Resolved Available
Dev dependencies
dart_style any
test any