shard

package

v0.7.0 Latest Latest Go to latest Published: Mar 7, 2023 License: Apache-2.0, MIT Imports: 3 Imported by: 24

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

This section is empty.

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

Key represents a shard key. It can be instantiated from a string, a byte slice, or a CID.

func KeyFromBytes(b []byte) Key

KeyFromBytes returns a key from a byte slice, encoding it in b58 first.

func KeyFromCID(cid cid.Cid) Key

KeyFromCID returns a key representing a CID.

func KeyFromString(str string) Key

KeyFromString returns a key representing an arbitrary string.

func (k Key) MarshalJSON() ([]byte, error)

We need a custom JSON marshaller and unmarshaller because str is a private field

func (k Key) String() string

String returns the string representation for this key.

func (k *Key) UnmarshalJSON(bz []byte) error