surrealpatch/util/keys/fd.go
Tobie Morgan Hitchcock 07139fdc5b Add database keys package
The keys package is used to encode and decode keys. Keys are used for storage in the key:value store.
2016-03-15 21:30:47 +00:00

53 lines
1.2 KiB
Go

// Copyright © 2016 Abcum Ltd
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package keys
import (
"strings"
)
// FD ...
type FD struct {
KV string // Base
CF string // !
TK string // f
NS string // Namespace
DB string // Database
TB string // Table
FD string // Field
}
// init initialises the key
func (k *FD) init() *FD {
k.CF = "!"
k.TK = "f"
return k
}
// Encode encodes the key into binary
func (k *FD) Encode() []byte {
return output(k.init())
}
// Decode decodes the key from binary
func (k *FD) Decode(data []byte) {
injest(k, data)
}
// String returns a string representation of the key
func (k *FD) String() string {
k.init()
return "/" + strings.Join([]string{k.KV, k.CF, k.TK, k.NS, k.DB, k.TB, k.FD}, "/")
}