ipld-eth-server/vendor/github.com/ipfs/go-mfs/README.md

go-mfs

go-mfs implements an in-memory model of a mutable IPFS filesystem.

Table of Contents

• Install
• Usage
• Contribute
• License

Install

go-mfs works like a regular Go module:

> go get github.com/ipfs/go-mfs

It uses Gx to manage dependencies. You can use make all to build it with the gx dependencies.

Usage

import "github.com/ipfs/go-mfs"

Check the GoDoc documentation

Documentation

Documentation around the MFS and the Files API in general around IPFS is a work in progress the following links may be of use:

• UnixFS
• MFS
• General concept document about how are files handled in IPFS (WIP)

Repository Structure

This repository contains many files, all belonging to the root mfs package.

• file.go: MFS File.
• dir.go: MFS Directory.
• fd.go: FileDescriptor used to operate on Files.
• ops.go: Functions that do not belong to either File nor Directory (although they mostly operate on them) that contain common operations to the MFS, e.g., find, move, add a file, make a directory.
• root.go: MFS Root (a Directory with republishing support).
• repub.go: Republisher.
• mfs_test.go: General tests (needs a revision).
• repub_test.go: Republisher-specific tests (contains only the TestRepublisher function).

Contribute

PRs accepted.

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

License

MIT © Protocol Labs, Inc.