rclone/vendor/storj.io/drpc/drpcmetadata/README.md

45 lines
944 B
Markdown
Raw Normal View History

2020-05-11 18:57:46 +00:00
# package drpcmetadata
`import "storj.io/drpc/drpcmetadata"`
Package drpcmetadata define the structure of the metadata supported by drpc
library.
## Usage
#### func Add
```go
func Add(ctx context.Context, key, value string) context.Context
```
Add associates a key/value pair on the context.
#### func AddPairs
```go
func AddPairs(ctx context.Context, metadata map[string]string) context.Context
2020-05-11 18:57:46 +00:00
```
AddPairs attaches metadata onto a context and return the context.
#### func Decode
```go
func Decode(data []byte) (map[string]string, error)
2020-05-11 18:57:46 +00:00
```
Decode translate byte form of metadata into key/value metadata.
2020-05-11 18:57:46 +00:00
#### func Encode
```go
func Encode(buffer []byte, metadata map[string]string) ([]byte, error)
2020-05-11 18:57:46 +00:00
```
Encode generates byte form of the metadata and appends it onto the passed in
buffer.
#### func Get
```go
func Get(ctx context.Context) (map[string]string, bool)
```
Get returns all key/value pairs on the given context.