ipns

Documentation

Overview

package fuse/ipns implements a fuse filesystem that interfaces with ipns, the naming system for ipfs.

Index

• func InitializeKeyspace(n *core.IpfsNode, key ci.PrivKey) error
• func Mount(ipfs *core.IpfsNode, ipnsmp, ipfsmp string) (mount.Mount, error)
• type Directory
  • func (d *Directory) Attr(ctx context.Context, a *fuse.Attr) error
  • func (dir *Directory) Create(ctx context.Context, req *fuse.CreateRequest, resp *fuse.CreateResponse) (fs.Node, fs.Handle, error)
  • func (s *Directory) Lookup(ctx context.Context, name string) (fs.Node, error)
  • func (dir *Directory) Mkdir(ctx context.Context, req *fuse.MkdirRequest) (fs.Node, error)
  • func (dir *Directory) ReadDirAll(ctx context.Context) ([]fuse.Dirent, error)
  • func (dir *Directory) Remove(ctx context.Context, req *fuse.RemoveRequest) error
  • func (dir *Directory) Rename(ctx context.Context, req *fuse.RenameRequest, newDir fs.Node) error
• type File
  • func (fi *File) Flush(ctx context.Context, req *fuse.FlushRequest) error
  • func (fi *File) Forget()
  • func (fi *File) Read(ctx context.Context, req *fuse.ReadRequest, resp *fuse.ReadResponse) error
  • func (fi *File) Release(ctx context.Context, req *fuse.ReleaseRequest) error
  • func (fi *File) Setattr(ctx context.Context, req *fuse.SetattrRequest, resp *fuse.SetattrResponse) error
  • func (fi *File) Write(ctx context.Context, req *fuse.WriteRequest, resp *fuse.WriteResponse) error
• type FileNode
  • func (fi *FileNode) Attr(ctx context.Context, a *fuse.Attr) error
  • func (fi *FileNode) Fsync(ctx context.Context, req *fuse.FsyncRequest) error
  • func (fi *FileNode) Open(ctx context.Context, req *fuse.OpenRequest, resp *fuse.OpenResponse) (fs.Handle, error)
• type FileSystem
  • func NewFileSystem(ctx context.Context, ipfs iface.CoreAPI, ipfspath, ipnspath string) (*FileSystem, error)
  • func (f *FileSystem) Destroy()
  • func (f *FileSystem) Root() (fs.Node, error)
• type Link
  • func (l *Link) Attr(ctx context.Context, a *fuse.Attr) error
  • func (l *Link) Readlink(ctx context.Context, req *fuse.ReadlinkRequest) (string, error)
• type Root
  • func CreateRoot(ctx context.Context, ipfs iface.CoreAPI, keys map[string]iface.Key, ...) (*Root, error)
  • func (*Root) Attr(ctx context.Context, a *fuse.Attr) error
  • func (r *Root) Close() error
  • func (r *Root) Forget()
  • func (s *Root) Lookup(ctx context.Context, name string) (fs.Node, error)
  • func (r *Root) ReadDirAll(ctx context.Context) ([]fuse.Dirent, error)

Functions

func InitializeKeyspace

func InitializeKeyspace(n *core.IpfsNode, key ci.PrivKey) error

InitializeKeyspace sets the ipns record for the given key to point to an empty directory.

func Mount

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

Mount mounts ipns at a given location, and returns a mount.Mount instance.

Types

type Directory

type Directory struct {
	// contains filtered or unexported fields
}

Directory is wrapper over an mfs directory to satisfy the fuse fs interface

func (*Directory) Attr

func (d *Directory) Attr(ctx context.Context, a *fuse.Attr) error

Attr returns the attributes of a given node.

func (*Directory) Create

func (dir *Directory) Create(ctx context.Context, req *fuse.CreateRequest, resp *fuse.CreateResponse) (fs.Node, fs.Handle, error)

func (*Directory) Lookup

func (s *Directory) Lookup(ctx context.Context, name string) (fs.Node, error)

Lookup performs a lookup under this node.

func (*Directory) Mkdir

func (dir *Directory) Mkdir(ctx context.Context, req *fuse.MkdirRequest) (fs.Node, error)

func (*Directory) ReadDirAll

func (dir *Directory) ReadDirAll(ctx context.Context) ([]fuse.Dirent, error)

ReadDirAll reads the link structure as directory entries

func (*Directory) Remove

func (dir *Directory) Remove(ctx context.Context, req *fuse.RemoveRequest) error

func (*Directory) Rename

func (dir *Directory) Rename(ctx context.Context, req *fuse.RenameRequest, newDir fs.Node) error

Rename implements NodeRenamer

type File

type File struct {
	// contains filtered or unexported fields
}

File is wrapper over an mfs file to satisfy the fuse fs interface

func (*File) Flush

func (fi *File) Flush(ctx context.Context, req *fuse.FlushRequest) error

func (*File) Forget

func (fi *File) Forget()

func (*File) Read

func (fi *File) Read(ctx context.Context, req *fuse.ReadRequest, resp *fuse.ReadResponse) error

func (*File) Release

func (fi *File) Release(ctx context.Context, req *fuse.ReleaseRequest) error

func (*File) Setattr

func (fi *File) Setattr(ctx context.Context, req *fuse.SetattrRequest, resp *fuse.SetattrResponse) error

func (*File) Write

func (fi *File) Write(ctx context.Context, req *fuse.WriteRequest, resp *fuse.WriteResponse) error

type FileNode

type FileNode struct {
	// contains filtered or unexported fields
}

func (*FileNode) Attr

func (fi *FileNode) Attr(ctx context.Context, a *fuse.Attr) error

Attr returns the attributes of a given node.

func (*FileNode) Fsync

func (fi *FileNode) Fsync(ctx context.Context, req *fuse.FsyncRequest) error

Fsync flushes the content in the file to disk.

func (*FileNode) Open

func (fi *FileNode) Open(ctx context.Context, req *fuse.OpenRequest, resp *fuse.OpenResponse) (fs.Handle, error)

type FileSystem

type FileSystem struct {
	Ipfs     iface.CoreAPI
	RootNode *Root
}

FileSystem is the readwrite IPNS Fuse Filesystem.

func NewFileSystem

func NewFileSystem(ctx context.Context, ipfs iface.CoreAPI, ipfspath, ipnspath string) (*FileSystem, error)

NewFileSystem constructs new fs using given core.IpfsNode instance.

func (*FileSystem) Destroy

func (f *FileSystem) Destroy()

func (*FileSystem) Root

func (f *FileSystem) Root() (fs.Node, error)

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

type Link

type Link struct {
	Target string
}

func (*Link) Attr

func (l *Link) Attr(ctx context.Context, a *fuse.Attr) error

func (*Link) Readlink

func (l *Link) Readlink(ctx context.Context, req *fuse.ReadlinkRequest) (string, error)

type Root

type Root struct {
	Ipfs iface.CoreAPI
	Keys map[string]iface.Key

	// Used for symlinking into ipfs
	IpfsRoot  string
	IpnsRoot  string
	LocalDirs map[string]fs.Node
	Roots     map[string]*mfs.Root

	LocalLinks map[string]*Link
}

Root is the root object of the filesystem tree.

func CreateRoot

func CreateRoot(ctx context.Context, ipfs iface.CoreAPI, keys map[string]iface.Key, ipfspath, ipnspath string) (*Root, error)

func (*Root) Attr

func (*Root) Attr(ctx context.Context, a *fuse.Attr) error

Attr returns file attributes.

func (*Root) Close

func (r *Root) Close() error

func (*Root) Forget

func (r *Root) Forget()

Forget is called when the filesystem is unmounted. probably. see comments here: http://godoc.org/bazil.org/fuse/fs#FSDestroyer

func (*Root) Lookup

func (s *Root) Lookup(ctx context.Context, name string) (fs.Node, error)

Lookup performs a lookup under this node.

func (*Root) ReadDirAll

func (r *Root) ReadDirAll(ctx context.Context) ([]fuse.Dirent, error)

ReadDirAll reads a particular directory. Will show locally available keys as well as a symlink to the peerID key