path

README

go-path

go-path is a helper package that provides utilities for parsing and using ipfs paths

Lead Maintainer

Steven Allen

Table of Contents

• API
• Contribute
• License

TODO

This package could probably be merged into go-ipld, or something along those lines. It doesnt really make sense as its own standalone thing.

Contribute

PRs are welcome!

Small note: If editing the Readme, please conform to the standard-readme specification.

License

MIT © Juan Batiz-Benet

Documentation

Overview

Package path contains utilities to work with ipfs paths.

Index

• func Join(pths []string) string
• func SplitAbsPath(fpath Path) (cid.Cid, []string, error)
• func SplitList(pth string) []string
• type ErrInvalidPath
  • func (e ErrInvalidPath) Error() string
  • func (e ErrInvalidPath) Is(err error) bool
  • func (e ErrInvalidPath) Unwrap() error
• type Path
  • func FromCid(c cid.Cid) Path
  • func FromSegments(prefix string, seg ...string) (Path, error)
  • func FromString(s string) Path
  • func ParseCidToPath(txt string) (Path, error)
  • func ParsePath(txt string) (Path, error)
  • func (p Path) IsJustAKey() bool
  • func (p *Path) IsValid() error
  • func (p Path) PopLastSegment() (Path, string, error)
  • func (p Path) Segments() []string
  • func (p Path) String() string

Functions

func Join

func Join(pths []string) string

Join joins strings slices using /

func SplitAbsPath

func SplitAbsPath(fpath Path) (cid.Cid, []string, error)

SplitAbsPath clean up and split fpath. It extracts the first component (which must be a Multihash) and return it separately.

func SplitList

func SplitList(pth string) []string

SplitList splits strings usings /

Types

type ErrInvalidPath

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

func (ErrInvalidPath) Error

func (e ErrInvalidPath) Error() string

func (ErrInvalidPath) Is

func (e ErrInvalidPath) Is(err error) bool

func (ErrInvalidPath) Unwrap

func (e ErrInvalidPath) Unwrap() error

type Path

type Path string

A Path represents an ipfs content path:

• <cid>/path/to/file
• /ipfs/<cid>
• /ipns/<cid>/path/to/folder
• etc

func FromCid

func FromCid(c cid.Cid) Path

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

func FromSegments

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

FromSegments returns a path given its different segments.

func FromString

func FromString(s string) Path

FromString safely converts a string type to a Path type.

func ParseCidToPath

func ParseCidToPath(txt string) (Path, error)

ParseCidToPath takes a CID in string form and returns a valid ipfs Path.

func ParsePath

func ParsePath(txt string) (Path, error)

ParsePath returns a well-formed ipfs Path. The returned path will always be prefixed with /ipfs/ or /ipns/. The prefix will be added if not present in the given string. This function will return an error when the given string is not a valid ipfs path.

func (Path) IsJustAKey

func (p Path) IsJustAKey() bool

IsJustAKey returns true if the path is of the form <key> or /ipfs/<key>, or /ipld/<key>

func (*Path) IsValid

func (p *Path) IsValid() error

IsValid checks if a path is a valid ipfs Path.

func (Path) PopLastSegment

func (p Path) PopLastSegment() (Path, string, error)

PopLastSegment returns a new Path without its final segment, and the final segment, separately. If there is no more to pop (the path is just a key), the original path is returned.

func (Path) Segments

func (p Path) Segments() []string

Segments returns the different elements of a path (elements are delimited by a /).

func (Path) String

func (p Path) String() string

String converts a path to string.