Categorygithub.com/ipfs/go-path
modulepackage
0.3.2
Repository: https://github.com/ipfs/go-path.git
Documentation: pkg.go.dev
Overview
Versions
1
Dependencies
4
Dependents
123
Files
162 SLOC

# README

go-path

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

Coverage Status Travis CI

ā— This repo is no longer maintained.

šŸ‘‰ We highly recommend switching to the maintained version at https://github.com/ipfs/boxo/tree/main/path. šŸŽļø Good news! There is tooling and documentation to expedite a switch in your repo.

āš ļø If you continue using this repo, please note that security fixes will not be provided (unless someone steps in to maintain it).

šŸ“š Learn more, including how to take the maintainership mantle or ask questions, here.

Table of Contents

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.

License

MIT Ā© Juan Batiz-Benet

# Packages

Package resolver implements utilities for resolving paths within ipfs.

# Functions

FromCid safely converts a cid.Cid type to a Path type.
FromSegments returns a path given its different segments.
FromString safely converts a string type to a Path type.
Join joins strings slices using / Deprecated: use github.com/ipfs/boxo/path.Join.
ParseCidToPath takes a CID in string form and returns a valid ipfs Path.
ParsePath returns a well-formed ipfs Path.
SplitAbsPath clean up and split fpath.
SplitList splits strings usings / Deprecated: use github.com/ipfs/boxo/path.SplitList.

# Structs

Deprecated: use github.com/ipfs/boxo/path.ErrInvalidPath.

# Type aliases

A Path represents an ipfs content path: - <cid>/path/to/file - /ipfs/<cid> - /ipns/<cid>/path/to/folder - etc Deprecated: use github.com/ipfs/boxo/path.Path.