path

Documentation

Overview

Package path implements utilities for resolving paths within ipfs.

Index

• Variables
• func Join(pths []string) string
• func SplitAbsPath(fpath Path) (mh.Multihash, []string, error)
• func SplitList(pth string) []string
• type ErrNoLink
  • func (e ErrNoLink) Error() string
• type Path
  • func FromKey(k key.Key) Path
  • func FromSegments(prefix string, seg ...string) (Path, error)
  • func FromString(s string) Path
  • func ParseKeyToPath(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
• type Resolver
  • func (s *Resolver) ResolveLinks(ctx context.Context, ndd *merkledag.Node, names []string) ([]*merkledag.Node, error)
  • func (s *Resolver) ResolvePath(ctx context.Context, fpath Path) (*merkledag.Node, error)
  • func (s *Resolver) ResolvePathComponents(ctx context.Context, fpath Path) ([]*merkledag.Node, error)

Variables

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

ErrBadPath is returned when a given path is incorrectly formatted

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

Paths after a protocol must contain at least one component

Functions

func Join

func Join(pths []string) string

func SplitAbsPath

func SplitAbsPath(fpath Path) (mh.Multihash, []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

Types

type ErrNoLink

type ErrNoLink struct {
	Name string
	Node mh.Multihash
}

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

func (ErrNoLink) Error

func (e ErrNoLink) Error() string

type 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 FromKey

func FromKey(k key.Key) Path

FromKey safely converts a Key type to a Path type

func FromSegments

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

func FromString

func FromString(s string) Path

FromString safely converts a string type to a Path type

func ParseKeyToPath

func ParseKeyToPath(txt string) (Path, error)

func ParsePath

func ParsePath(txt string) (Path, error)

func (Path) IsJustAKey

func (p Path) IsJustAKey() bool

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

func (*Path) IsValid

func (p *Path) IsValid() error

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

func (Path) String

func (p Path) String() string

type Resolver

type Resolver struct {
	DAG merkledag.DAGService
}

Resolver provides path resolution to IPFS It has a pointer to a DAGService, which is uses to resolve nodes.

func (*Resolver) ResolveLinks

func (s *Resolver) ResolveLinks(ctx context.Context, ndd *merkledag.Node, names []string) ([]*merkledag.Node, error)

ResolveLinks iteratively resolves names by walking the link hierarchy. Every node is fetched from the DAGService, resolving the next name. Returns the list of nodes forming the path, starting with ndd. This list is guaranteed never to be empty.

ResolveLinks(nd, []string{"foo", "bar", "baz"}) would retrieve "baz" in ("bar" in ("foo" in nd.Links).Links).Links

func (*Resolver) ResolvePath

func (s *Resolver) ResolvePath(ctx context.Context, fpath Path) (*merkledag.Node, error)

ResolvePath fetches the node for given path. It returns the last item returned by ResolvePathComponents.

func (*Resolver) ResolvePathComponents

func (s *Resolver) ResolvePathComponents(ctx context.Context, fpath Path) ([]*merkledag.Node, error)

ResolvePathComponents fetches the nodes for each segment of the given path. It uses the first path component as a hash (key) of the first node, then resolves all other components walking the links, with ResolveLinks.