Documentation
¶
Overview ¶
Package path contains utilities to work with ipfs paths.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func SplitAbsPath ¶
SplitAbsPath clean up and split fpath. It extracts the first component (which must be a Multihash) and return it separately.
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 FromSegments ¶
FromSegments returns a path given its different segments.
func FromString ¶
FromString safely converts a string type to a Path type.
func ParseCidToPath ¶
ParseCidToPath takes a CID in string form and returns a valid ipfs Path.
func ParsePath ¶
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 ¶
IsJustAKey returns true if the path is of the form <key> or /ipfs/<key>, or /ipld/<key>
func (Path) PopLastSegment ¶
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.
Source Files
Directories