From 8ad59edd02a8ea6001f15cd6d92944ae83c88f6d Mon Sep 17 00:00:00 2001 From: Ben Johnson Date: Wed, 12 Feb 2014 14:57:27 -0700 Subject: API Documentation. --- bucket.go | 5 +++++ 1 file changed, 5 insertions(+) (limited to 'bucket.go') diff --git a/bucket.go b/bucket.go index 28c570e..414d260 100644 --- a/bucket.go +++ b/bucket.go @@ -1,11 +1,16 @@ package bolt +// Bucket represents a collection of key/value pairs inside the database. +// All keys inside the bucket are unique. The Bucket type is not typically used +// directly. Instead the bucket name is typically passed into the Get(), Put(), +// or Delete() functions. type Bucket struct { *bucket name string transaction *Transaction } +// bucket represents the on-file representation of a bucket. type bucket struct { root pgid } -- cgit v1.2.3