readonly

Documentation

Overview

package fuse/readonly implements a fuse filesystem to access files stored inside of ipfs.

Index

• func Mount(ipfs *core.IpfsNode, fpath string) (mount.Mount, error)
• type FileSystem
  • func NewFileSystem(ipfs *core.IpfsNode) *FileSystem
  • func (f FileSystem) Root() (fs.Node, fuse.Error)
• type Node
  • func (s *Node) Attr() fuse.Attr
  • func (s *Node) Lookup(name string, intr fs.Intr) (fs.Node, fuse.Error)
  • func (s *Node) ReadAll(intr fs.Intr) ([]byte, fuse.Error)
  • func (s *Node) ReadDir(intr fs.Intr) ([]fuse.Dirent, fuse.Error)
• type Root
  • func (*Root) Attr() fuse.Attr
  • func (s *Root) Lookup(name string, intr fs.Intr) (fs.Node, fuse.Error)
  • func (*Root) ReadDir(intr fs.Intr) ([]fuse.Dirent, fuse.Error)

Functions

func Mount

func Mount(ipfs *core.IpfsNode, fpath string) (mount.Mount, error)

Mount mounts an IpfsNode instance at a particular path. It serves until the process receives exit signals (to Unmount).

Types

type FileSystem

type FileSystem struct {
	Ipfs *core.IpfsNode
}

FileSystem is the readonly Ipfs Fuse Filesystem.

func NewFileSystem

func NewFileSystem(ipfs *core.IpfsNode) *FileSystem

NewFileSystem constructs new fs using given core.IpfsNode instance.

func (FileSystem) Root

func (f FileSystem) Root() (fs.Node, fuse.Error)

Root constructs the Root of the filesystem, a Root object.

type Node

type Node struct {
	Ipfs *core.IpfsNode
	Nd   *mdag.Node
	// contains filtered or unexported fields
}

Node is the core object representing a filesystem tree node.

func (*Node) Attr

func (s *Node) Attr() fuse.Attr

Attr returns the attributes of a given node.

func (*Node) Lookup

func (s *Node) Lookup(name string, intr fs.Intr) (fs.Node, fuse.Error)

Lookup performs a lookup under this node.

func (*Node) ReadAll

func (s *Node) ReadAll(intr fs.Intr) ([]byte, fuse.Error)

ReadAll reads the object data as file data

func (*Node) ReadDir

func (s *Node) ReadDir(intr fs.Intr) ([]fuse.Dirent, fuse.Error)

ReadDir reads the link structure as directory entries

type Root

type Root struct {
	Ipfs *core.IpfsNode
}

Root is the root object of the filesystem tree.

func (*Root) Attr

func (*Root) Attr() fuse.Attr

Attr returns file attributes.

func (*Root) Lookup

func (s *Root) Lookup(name string, intr fs.Intr) (fs.Node, fuse.Error)

Lookup performs a lookup under this node.

func (*Root) ReadDir

func (*Root) ReadDir(intr fs.Intr) ([]fuse.Dirent, fuse.Error)

ReadDir reads a particular directory. Disallowed for root.