mfs

package

v0.40.0 Latest Latest Go to latest Published: Feb 25, 2026 License: Apache-2.0, MIT, Apache-2.0, + 1 more Imports: 13 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/ipfs/kubo

Links

Open Source Insights

Documentation ¶

Rendered for

Index ¶

func Mount(ipfs *core.IpfsNode, mountpoint string) (mount.Mount, error)
func NewFileSystem(ipfs *core.IpfsNode) fs.FS
type Dir
type File
type FileHandler
type FileSystem
- func (fs *FileSystem) Root() (fs.Node, error)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Mount ¶

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

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

func NewFileSystem ¶

func NewFileSystem(ipfs *core.IpfsNode) fs.FS

Create new filesystem.

Types ¶

type Dir ¶

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

FUSE Adapter for MFS directories.

func (*Dir) Attr ¶

func (dir *Dir) Attr(ctx context.Context, attr *fuse.Attr) error

Directory attributes (stat).

func (*Dir) Create ¶

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

Create (touch) an MFS file.

func (*Dir) Getxattr ¶

func (dir *Dir) Getxattr(ctx context.Context, req *fuse.GetxattrRequest, resp *fuse.GetxattrResponse) error

Get dir xattr.

func (*Dir) Listxattr ¶

func (dir *Dir) Listxattr(ctx context.Context, req *fuse.ListxattrRequest, resp *fuse.ListxattrResponse) error

List dir xattr.

func (*Dir) Lookup ¶

func (dir *Dir) Lookup(ctx context.Context, req *fuse.LookupRequest, resp *fuse.LookupResponse) (fs.Node, error)

Access files in a directory.

func (*Dir) Mkdir ¶

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

Mkdir (mkdir) in MFS.

func (*Dir) ReadDirAll ¶

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

List (ls) MFS directory.

func (*Dir) Remove ¶

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

Remove (rm/rmdir) an MFS file.

func (*Dir) Rename ¶

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

Move (mv) an MFS file.

type File ¶

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

FUSE adapter for MFS files.

func (*File) Attr ¶

func (file *File) Attr(ctx context.Context, attr *fuse.Attr) error

File attributes.

func (*File) Fsync ¶

func (file *File) Fsync(ctx context.Context, req *fuse.FsyncRequest) error

Sync the file's contents to MFS.

func (*File) Getxattr ¶

func (file *File) Getxattr(ctx context.Context, req *fuse.GetxattrRequest, resp *fuse.GetxattrResponse) error

Get file xattr.

func (*File) Listxattr ¶

func (file *File) Listxattr(ctx context.Context, req *fuse.ListxattrRequest, resp *fuse.ListxattrResponse) error

List file xattr.

func (*File) Open ¶

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

Open an MFS file.

type FileHandler ¶

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

Wrapper for MFS's file descriptor that conforms to the FUSE fs.Handler interface.

func (*FileHandler) Flush ¶

func (fh *FileHandler) Flush(ctx context.Context, req *fuse.FlushRequest) error

Flushes the file's buffer.

func (*FileHandler) Read ¶

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

Read a opened MFS file.

func (*FileHandler) Release ¶

func (fh *FileHandler) Release(ctx context.Context, req *fuse.ReleaseRequest) error

Closes the file.

func (*FileHandler) Write ¶

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

Write writes to an opened MFS file.

type FileSystem ¶

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

FUSE filesystem mounted at /mfs.

func (*FileSystem) Root ¶

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

Get filesystem root.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL