flash

package module
v1.0.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 24, 2016 License: MIT Imports: 10 Imported by: 0

README

Flash

BoltDB wrapper

Build Status codecov.io

Installation

go get github.com/kakilangit/flash

Usage

import "github.com/kakilangit/flash"


f := flash.NewFlash("", "prefix", "filename")
f.Set("bucketName", "key", []byte("value"))
value := f.Get("bucketName", "key")

The MIT License (MIT)

Copyright (c) 2016 kakilangit

theguywhodrinkscoffeeandcodes@gmail.com

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Documentation

Overview

Package flash is thin wrapper for fast key value database: bolt.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Flash

type Flash interface {
	Set(bucketName, key string, value []byte) error
	Get(bucketName, key string) []byte
	Delete(bucketName, key string) error
}

Flash is flash interface, between passing struct or interface: use interface

type RedStreak

type RedStreak struct {
	// contains filtered or unexported fields
}

RedStreak struct will keep the file db & bucket name

func NewFlash

func NewFlash(path, prefix, filedef string) *RedStreak

NewFlash will create new RedStreak pointer with dependency injection pattern for the sake of testable function

func (*RedStreak) Delete

func (barry *RedStreak) Delete(bucketName, key string) error

Delete key

func (*RedStreak) Get

func (barry *RedStreak) Get(bucketName, key string) (value []byte)

Get value from the key provided

func (*RedStreak) Set

func (barry *RedStreak) Set(bucketName, key string, value []byte) error

Set value for specified key

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL