stash_sembast 1.0.1 copy "stash_sembast: ^1.0.1" to clipboard
stash_sembast: ^1.0.1 copied to clipboard

outdated

Sembast storage extension for the stash caching API. Provides support to store caches int the local file system in binary format using the msgpack json format

stash_sembast #

A stash storage extension for sembast

Pub Package Build Status Coverage Status Package Documentation GitHub License

Introduction #

This storage extension for stash provides a sembast 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):

dependencies:
    stash_sembast: ^1.0.1

Run the following command to install dependencies:

pub install

Optionally use the following command to run the tests:

pub run test

Finally, to start developing import the library:

import 'package:stash_sembast/stash_sembast.dart';

Usage #

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

import 'dart:io';

import 'package:stash_sembast/stash_sembast.dart';

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

  Task({this.id, 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 cache with a Sembast based storage backend with the capacity of 10 entries
  final cache = newSembastCache(path,
      maxEntries: 10, fromEncodable: (json) => Task.fromJson(json));

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

  print(value);
}

Contributing #

This library is developed by best effort, in the motto of "Scratch your own itch!", meaning APIs that are meaningful for the author use cases.

If you would like to contribute with other parts of the API, feel free to make a Github pull request as I'm always looking for contributions for:

  • Tests
  • Documentation
  • New APIs

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

2
likes
0
pub points
59%
popularity

Publisher

verified publisherivoleitao.dev

Sembast storage extension for the stash caching API. Provides support to store caches int the local file system in binary format using the msgpack json format

Repository (GitHub)
View/report issues

License

unknown (license)

Dependencies

path, sembast, stash

More

Packages that depend on stash_sembast