hashlink

Documentation

Index

• Constants
• func GetHashLink(resource, metadata string) string
• func GetHashLinkFromResourceHash(resource string) string
• func GetResourceHashFromHashLink(hashLink string) (string, error)
• func ToString(hl ...*url.URL) string
• type Decoder
• type Encoder
• type HashLink
  • func New(opts ...Option) *HashLink
  • func (hl *HashLink) CreateHashLink(content []byte, links []string) (string, error)
  • func (hl *HashLink) CreateMetadataFromLinks(links []string) (string, error)
  • func (hl *HashLink) CreateResourceHash(content []byte) (string, error)
  • func (hl *HashLink) GetLinksFromMetadata(enc string) ([]string, error)
  • func (hl *HashLink) ParseHashLink(hashLink string) (*Info, error)
• type Info
• type Option
  • func WithDecoder(dec Decoder) Option
  • func WithEncoder(enc Encoder) Option
  • func WithMultihashCode(mhCode uint) Option

Constants

const (

	// HLPrefix is hash link prefix.
	HLPrefix = hl + separator
)

Functions

func GetHashLink

func GetHashLink(resource, metadata string) string

GetHashLink will create hashlink from resource hash and metadata.

func GetHashLinkFromResourceHash

func GetHashLinkFromResourceHash(resource string) string

GetHashLinkFromResourceHash will create hashlink from resource hash.

func GetResourceHashFromHashLink

func GetResourceHashFromHashLink(hashLink string) (string, error)

GetResourceHashFromHashLink will return resource hash.

func ToString

func ToString(hl ...*url.URL) string

ToString parses the given hashlink(s) and returns a human-readable form.

Types

type Decoder

type Decoder func(encodedContent string) ([]byte, error)

Decoder defines decoding function.

type Encoder

type Encoder func(content []byte) string

Encoder defines encoding function.

type HashLink

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

HashLink implements hashlink related functionality.

func New

func New(opts ...Option) *HashLink

New creates HashLink.

func (*HashLink) CreateHashLink

func (hl *HashLink) CreateHashLink(content []byte, links []string) (string, error)

CreateHashLink will create hashlink for the supplied content and links.

func (*HashLink) CreateMetadataFromLinks

func (hl *HashLink) CreateMetadataFromLinks(links []string) (string, error)

CreateMetadataFromLinks will create metadata for the supplied links.

func (*HashLink) CreateResourceHash

func (hl *HashLink) CreateResourceHash(content []byte) (string, error)

CreateResourceHash will create resource hash for the supplied content.

func (*HashLink) GetLinksFromMetadata

func (hl *HashLink) GetLinksFromMetadata(enc string) ([]string, error)

GetLinksFromMetadata will create links from metadata.

func (*HashLink) ParseHashLink

func (hl *HashLink) ParseHashLink(hashLink string) (*Info, error)

ParseHashLink will parse hash link into resource hash and metadata.

type Info

type Info struct {
	ResourceHash string
	Links        []string
}

Info contains hashlink information: resource hash and links.

type Option

type Option func(opts *HashLink)

Option is a hashlink instance option.

func WithDecoder

func WithDecoder(dec Decoder) Option

WithDecoder option is for specifying custom decoder.

func WithEncoder

func WithEncoder(enc Encoder) Option

WithEncoder option is for specifying custom encoder.

func WithMultihashCode

func WithMultihashCode(mhCode uint) Option

WithMultihashCode option is for specifying custom multihash code.