path

package

v0.0.0-...-241d124 Latest Latest Go to latest Published: Dec 19, 2019 License: MIT Imports: 5 Imported by: 0

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.

View Source

var ErrBadPath = errors.New("invalid ipfs ref path")

ErrBadPath is returned when a given path is incorrectly formatted

View Source

var ErrNoComponents = errors.New(
	"path must contain at least one component")

Paths after a protocol must contain at least one component

This section is empty.

type ErrNoLink struct {
	Name string
	Node mh.Multihash
}

ErrNoLink is returned when a link is not found in a path

type Path string

TODO: debate making this a private struct wrapped in a public interface would allow us to control creation, and cache segments.

func FromCid(c *cid.Cid) Path

FromCid safely converts a cid.Cid type to a Path type

func FromSegments(prefix string, seg ...string) (Path, error)

func FromString(s string) Path

FromString safely converts a string type to a Path type

func ParseCidToPath(txt string) (Path, error)

func ParsePath(txt string) (Path, error)

func (p *Path) IsValid() error

func (p Path) Segments() []string

func (p Path) String() string