files

package
v0.0.31 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 28, 2026 License: AGPL-3.0 Imports: 17 Imported by: 0

Documentation

Index

Constants

View Source
const (
	DirPerm  = os.FileMode(0o0750)
	FilePerm = os.FileMode(0o0640)
	MaxSize  = 64 << 20 // 64MiB
)

Variables

View Source
var (
	ErrExpectMountFormat = errors.New("expected mount format to be: <vfs>:<src>:<dest>, missing some parts")
	ErrInvalidVFSType    = errors.New("invalid VFS type")
)
View Source
var ErrReadOnly = errors.New("filesystem is read-only")

Functions

func FilesFlagSet added in v0.0.2

func FilesFlagSet() (*flag.FlagSet, func() FilesConfig)

func SessionsFlagSet

func SessionsFlagSet() (*flag.FlagSet, func() SessionsConfig)

Types

type Files

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

Files is the service instance for teapot's file storage service.

func NewFiles

func NewFiles(config FilesConfig, logger *slog.Logger) (*Files, error)

NewFiles returns a new Files service instance.

func (*Files) LDAPFactory

func (f *Files) LDAPFactory() *ldap.Factory

func (*Files) LivenessChecks added in v0.0.3

func (f *Files) LivenessChecks() map[string]observability.Check

LivenessChecks implements observability.LivenessChecks.

func (*Files) Metrics added in v0.0.3

func (f *Files) Metrics() []prometheus.Collector

Metrics implements observability.Metrics.

func (*Files) ReadinessChecks added in v0.0.3

func (f *Files) ReadinessChecks() map[string]observability.Check

ReadinessChecks implements observability.ReadinessChecks.

func (*Files) Sesssions

func (f *Files) Sesssions() *Sessions

type FilesConfig

type FilesConfig struct {
	LDAP     ldap.LDAPConfig
	Mounts   []string
	Sessions SessionsConfig
}

FilesConfig is the configuration for the Files service.

type ReadOnlyFS

type ReadOnlyFS[FS hpfs.FS] struct {
	// contains filtered or unexported fields
}

func NewReadOnlyFS

func NewReadOnlyFS[FS hpfs.FS](fs FS) ReadOnlyFS[FS]

NewReadOnlyFS returns a new read-only FS which proxies all calls to the underlying FS, and returns an error for any write call.

func (ReadOnlyFS[FS]) Open

func (fs ReadOnlyFS[FS]) Open(name string) (hpfs.File, error)

Open implements hackpadfs.FS.

type Session

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

func (*Session) FS

func (s *Session) FS() hpfs.FS

type Sessions

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

func NewSessions

func NewSessions(config SessionsConfig, logger *slog.Logger) (*Sessions, error)

func (*Sessions) Get

func (s *Sessions) Get(username string) (*Session, error)

type SessionsCache

type SessionsCache = *tlru.Cache[string, *Session]

type SessionsConfig

type SessionsConfig struct {
	Mounts        []string
	CacheSize     int
	CacheLifetime time.Duration
}

type VFS

type VFS uint8
const (
	VFSOS VFS = iota
)

func (VFS) String

func (vfs VFS) String() string

Directories

Path Synopsis

Jump to

Keyboard shortcuts

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