defs

README

DeFS

DeFS(Decentralized file service) 去中心化文件服务，引领了数据存储领域的革新，通过引入动态存储技术，解决了传统静态存储和去中心化存储所面临的挑战。其核心设计理念是为用户提供更加高效、安全且可靠的数据存储解决方案。通过数据的自由流动和动态迁移，在去中心化的同时，又保障了数据的安全性和可靠性。

该项目目前正在积极开发中，处于 Alpha 状态。

文档

该文档正在编写中……

Documentation

Index

• type FS
  • func Open(opt *opts.Options, p2p *dep2p.DeP2P, pub *pubsub.DeP2PPubSub) (*FS, error)
  • func (fs *FS) Afero() afero.Afero
  • func (fs *FS) Ctx() context.Context
  • func (fs FS) DirExists(path string) (bool, error)
  • func (fs *FS) Download() *downloads.DownloadManager
  • func (fs *FS) DownloadChan() chan *downloads.DownloadChan
  • func (fs FS) Exists(path string) (bool, error)
  • func (fs FS) FileContainsAnyBytes(filename string, subslices [][]byte) (bool, error)
  • func (fs FS) FileContainsBytes(filename string, subslice []byte) (bool, error)
  • func (fs FS) GetTempDir(subPath string) string
  • func (fs FS) IsDir(path string) (bool, error)
  • func (fs FS) IsEmpty(path string) (bool, error)
  • func (fs *FS) Opt() *opts.Options
  • func (fs *FS) P2P() *dep2p.DeP2P
  • func (fs *FS) Pubsub() *pubsub.DeP2PPubSub
  • func (fs FS) ReadDir(dirname string) ([]os.FileInfo, error)
  • func (fs FS) ReadFile(filename string) ([]byte, error)
  • func (fs FS) SafeWriteReader(path string, r io.Reader) (err error)
  • func (fs FS) TempDir(dir, prefix string) (name string, err error)
  • func (fs FS) TempFile(dir, pattern string) (f afero.File, err error)
  • func (fs *FS) Upload() *uploads.UploadManager
  • func (fs *FS) UploadChan() chan *uploads.UploadChan
  • func (fs FS) Walk(root string, walkFn filepath.WalkFunc) error
  • func (fs FS) WriteFile(filename string, data []byte, perm os.FileMode) error
  • func (fs FS) WriteReader(path string, r io.Reader) (err error)

Types

type FS

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

FS 是一个封装了DeFS去中心化(动态)存储的结构体

func Open

func Open(opt *opts.Options, p2p *dep2p.DeP2P, pub *pubsub.DeP2PPubSub) (*FS, error)

Open 返回一个新的文件存储对象

func (*FS) Afero

func (fs *FS) Afero() afero.Afero

Afero 获取文件系统接口

func (*FS) Ctx

func (fs *FS) Ctx() context.Context

Ctx 获取全局上下文

func (FS) DirExists

func (fs FS) DirExists(path string) (bool, error)

DirExists 检查路径是否存在并且是一个目录。 参数：

• path: string 路径

返回值：

• bool: 是否存在并且是目录
• error: 错误信息

func (*FS) Download

func (fs *FS) Download() *downloads.DownloadManager

Download 管理所有下载会话

func (*FS) DownloadChan

func (fs *FS) DownloadChan() chan *downloads.DownloadChan

DownloadChan 下载对外通道

func (FS) Exists

func (fs FS) Exists(path string) (bool, error)

Exists 检查文件或目录是否存在。 参数：

• path: string 路径

返回值：

• bool: 是否存在
• error: 错误信息

func (FS) FileContainsAnyBytes

func (fs FS) FileContainsAnyBytes(filename string, subslices [][]byte) (bool, error)

FileContainsAnyBytes 检查文件是否包含任意一个指定的字节切片 参数：

• filename: string 文件名
• subslices: [][]byte 字节切片数组

返回值：

• bool: 是否包含
• error: 错误信息

func (FS) FileContainsBytes

func (fs FS) FileContainsBytes(filename string, subslice []byte) (bool, error)

FileContainsBytes 检查文件是否包含指定的字节切片 参数：

• filename: string 文件名
• subslice: []byte 字节切片

返回值：

• bool: 是否包含
• error: 错误信息

func (FS) GetTempDir

func (fs FS) GetTempDir(subPath string) string

GetTempDir 获取临时目录路径 参数：

• subPath: string 子路径

返回值：

• string: 临时目录路径

func (FS) IsDir

func (fs FS) IsDir(path string) (bool, error)

IsDir 检查给定路径是否是目录。 参数：

• path: string 路径

返回值：

• bool: 是否是目录
• error: 错误信息

func (FS) IsEmpty

func (fs FS) IsEmpty(path string) (bool, error)

IsEmpty 检查给定文件或目录是否为空。 参数：

• path: string 路径

返回值：

• bool: 是否为空
• error: 错误信息

func (*FS) Opt

func (fs *FS) Opt() *opts.Options

Opt 获取文件存储选项配置

func (*FS) P2P

func (fs *FS) P2P() *dep2p.DeP2P

P2P 获取DeP2P网络主机

func (*FS) Pubsub

func (fs *FS) Pubsub() *pubsub.DeP2PPubSub

Pubsub 获取DeP2P网络订阅

func (FS) ReadDir

func (fs FS) ReadDir(dirname string) ([]os.FileInfo, error)

ReadDir 读取指定目录的内容并返回排序后的目录条目列表 参数：

• dirname: string 目录名

返回值：

• []os.FileInfo: 目录条目列表
• error: 错误信息

func (FS) ReadFile

func (fs FS) ReadFile(filename string) ([]byte, error)

ReadFile 读取指定文件的内容并返回 参数：

• filename: string 文件名

返回值：

• []byte: 文件内容
• error: 错误信息

func (FS) SafeWriteReader

func (fs FS) SafeWriteReader(path string, r io.Reader) (err error)

SafeWriteReader 将读取器的内容安全地写入指定路径 参数：

• path: string 文件路径
• r: io.Reader 读取器

返回值：

• error: 错误信息

func (FS) TempDir

func (fs FS) TempDir(dir, prefix string) (name string, err error)

TempDir 在指定目录中创建一个新的临时目录 参数：

• dir: string 目录路径
• prefix: string 目录名前缀

返回值：

• string: 目录路径
• error: 错误信息

func (FS) TempFile

func (fs FS) TempFile(dir, pattern string) (f afero.File, err error)

TempFile 在指定目录中创建一个新的临时文件 参数：

• dir: string 目录路径
• pattern: string 文件名模式

返回值：

• File: 临时文件对象
• error: 错误信息

func (*FS) Upload

func (fs *FS) Upload() *uploads.UploadManager

Upload 管理所有上传会话

func (*FS) UploadChan

func (fs *FS) UploadChan() chan *uploads.UploadChan

UploadChan 上传对外通道

func (FS) Walk

func (fs FS) Walk(root string, walkFn filepath.WalkFunc) error

Walk 遍历根目录为 root 的文件树，调用 walkFn 函数处理树中的每个文件或目录，包括根目录。 参数：

• root: string 根目录
• walkFn: filepath.WalkFunc 处理函数

返回值：

• error: 错误信息

func (FS) WriteFile

func (fs FS) WriteFile(filename string, data []byte, perm os.FileMode) error

WriteFile 将数据写入指定名称的文件 参数：

• filename: string 文件名
• data: []byte 数据
• perm: os.FileMode 文件权限

返回值：

• error: 错误信息

func (FS) WriteReader

func (fs FS) WriteReader(path string, r io.Reader) (err error)

WriteReader 将读取器的内容写入指定路径 参数：

• path: string 文件路径
• r: io.Reader 读取器

返回值：

• error: 错误信息