Commit 1a2cc280 authored by Juan Batiz-Benet's avatar Juan Batiz-Benet

Merge pull request #16 from tv42/fs-doc

Package fs docs
parents a113e955 1199735c
// Package fs is a simple Datastore implementation that stores keys
// are directories and files, mirroring the key. That is, the key
// "/foo/bar" is stored as file "PATH/foo/bar/.dsobject".
//
// This means key some segments will not work. For example, the
// following keys will result in unwanted behavior:
//
// - "/foo/./bar"
// - "/foo/../bar"
// - "/foo\x00bar"
//
// Keys that only differ in case may be confused with each other on
// case insensitive file systems, for example in OS X.
//
// This package is intended for exploratory use, where the user would
// examine the file system manually, and should only be used with
// human-friendly, trusted keys. You have been warned.
package fs
import (
......@@ -13,7 +30,7 @@ import (
var ObjectKeySuffix = ".dsobject"
// Datastore uses a standard Go map for internal storage.
// Datastore uses a uses a file per key to store values.
type Datastore struct {
path string
}
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment