stash_objectbox

A stash storage extension for objectbox

Pub Package Coverage Status Package Documentation GitHub License

Overview

This storage extension for stash provides a objectbox based storage that relies on a highly performing binary serialization of the cache items through the use of msgpack serialization format.

Getting Started

Add this to your pubspec.yaml (or create it) replacing x.x.x with the latest version of stash_objectbox:

dependencies:
    stash_objectbox: ^x.x.x

Run the following command to install dependencies:

dart pub get

Finally, to start developing import the library:

import 'package:stash_objectbox/stash_objectbox.dart';

Usage

The example bellow creates a cache with a Objectbox storage backend that supports a maximum of 10 Task objects. In the rather simple example bellow the serialization and deserialization of the object is coded by hand but normally it relies on the usage of libraries like json_serializable. Please take a look at the documentation of stash to gather additional information and to explore the full range of capabilities of the stash library

import 'dart:io';

import 'package:stash/stash_api.dart';
import 'package:stash_objectbox/stash_objectbox.dart';

class Task {
  final int id;
  final String title;
  final bool completed;

  Task({required this.id, required this.title, this.completed = false});

  /// Creates a [Task] from json map
  factory Task.fromJson(Map<String, dynamic> json) => Task(
      id: json['id'] as int,
      title: json['title'] as String,
      completed: json['completed'] as bool);

  /// Creates a json map from a [Task]
  Map<String, dynamic> toJson() =>
      <String, dynamic>{'id': id, 'title': title, 'completed': completed};

  @override
  String toString() {
    return 'Task $id: "$title" is ${completed ? "completed" : "not completed"}';
  }
}

void main() async {
  // Temporary path
  final path = Directory.systemTemp.path;

  // Creates a memory based cache with a a capacity of 10
  final cache = newObjectBoxCache(path,
      maxEntries: 10,
      eventListenerMode: EventListenerMode.Sync,
      fromEncodable: (json) => Task.fromJson(json))
    ..on<CreatedEntryEvent>().listen(
        (event) => print('Entry key "${event.entry.key}" added to the cache'));

  // Adds a task with key 'task1' to the cache
  await cache.put('task1',
      Task(id: 1, title: 'Run stash_objectbox example', completed: true));
  // Retrieves the value from the cache
  final value = await cache.get('task1');

  print(value);
}

Features and Bugs

Please file feature requests and bugs at the issue tracker.

License

This project is licensed under the MIT License - see the LICENSE file for details

Libraries

example
objectbox.g
stash_objectbox
Provides a Objectbox implementation of the Stash caching API for Dart