fskitbridge

type AccessCheckVolume interface {
	Volume

	// CheckAccess reports whether the requested access to item is allowed.
	CheckAccess(item Item, access fskit.FSAccessMask) (bool, error)
}

type CapabilitiesVolume interface {
	Volume

	// SupportedCapabilities returns the volume's capabilities.
	SupportedCapabilities() fskit.FSVolumeSupportedCapabilities
}

type ClassConfig struct {
	FileSystemName      string
	VolumeName          string
	ItemName            string
	ExistingFileSystem  objc.Class
	FileSystemProtocols []string
	VolumeProtocols     []string
	FileSystemMethods   []objc.MethodDef
	VolumeMethods       []objc.MethodDef
	ItemMethods         []objc.MethodDef
}

type ClassSet struct {
	FileSystem objc.Class
	Volume     objc.Class
	Item       objc.Class
}

type DirEntry struct {
	Name       string
	Type       fskit.FSItemType
	Attributes fskit.FSItemAttributes // must include the entry's file ID
}

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

type Item any

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

type LinkVolume interface {
	Volume

	// Link links item under a new name in dir.
	Link(item Item, dir Item, name string) error
}

type MutableVolume interface {
	Volume

	// Create creates a file (FSItemTypeFile) or directory
	// (FSItemTypeDirectory) named name in dir.
	Create(dir Item, name string, typ fskit.FSItemType, mode uint32) (Item, error)

	// Remove removes the item named name from dir.
	Remove(dir Item, name string, item Item) error

	// Rename moves item, named srcName in srcDir, to dstName in dstDir.
	// If over is non-nil the destination exists and is replaced; the
	// Server reclaims over after a successful rename.
	Rename(item Item, srcDir Item, srcName string, dstDir Item, dstName string, over Item) error

	// SetAttributes applies the requested attribute changes to item and
	// returns the subset it actually applied, as the fields left non-nil.
	// A Volume that applied everything returns set unchanged.
	//
	// The Server reports the returned subset to FSKit as the consumed
	// attributes, and FSKit takes an unconsumed attribute as one the file
	// system does not support: that is how a caller learns a chown did not
	// happen instead of believing a silent success. Returning the applied
	// set rather than clearing an in-out parameter keeps the mistake of
	// forgetting to report cheap -- the zero value claims nothing, so an
	// implementer who gets it wrong under-claims.
	SetAttributes(item Item, set SetAttributes) (applied SetAttributes, err error)

	// Write writes data to file at offset, returning the number of bytes
	// written.
	Write(file Item, offset int64, data []byte) (int, error)
}

type OpenCloseVolume interface {
	Volume

	// Open notes that item was opened with the given modes.
	Open(item Item, modes fskit.FSVolumeOpenModes) error

	// Close notes that item was closed, keeping the given modes.
	Close(item Item, modes fskit.FSVolumeOpenModes) error
}

type PathConf struct {
	MaximumLinkCount          int
	MaximumNameLength         int
	MaximumFileSize           uint64
	MaximumXattrSize          int
	RestrictsOwnershipChanges bool
	TruncatesLongNames        bool

	// OpenUnlinkEmulation asks FSKit to emulate open-unlink semantics,
	// for volumes that cannot keep unlinked-but-open files alive.
	OpenUnlinkEmulation bool
}

type PathConfVolume interface {
	Volume

	// PathConf returns the volume's path configuration limits.
	PathConf() PathConf
}

type PreallocateVolume interface {
	Volume

	// Preallocate reserves length bytes at offset in file, returning the
	// number of bytes reserved.
	Preallocate(file Item, offset int64, length uint64) (uint64, error)
}

type ProbeResult struct {
	Name string
}

type ReplyBlockShims struct {
	Error    string
	Object   string
	ItemName string
	Verifier string
	Bool     string
	Size     string
}

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

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

type ServerConfig struct {
	// FileSystemName, VolumeName, and ItemName name the Objective-C
	// classes the Server registers.
	FileSystemName string
	VolumeName     string
	ItemName       string

	// ExistingFileSystem, if nonzero, is used as the file system class
	// instead of registering one; see [ClassConfig]. The host shim then
	// routes operations to the Server through [Server.ProbeResource],
	// [Server.LoadResource], and [Server.UnloadResource].
	ExistingFileSystem objc.Class

	// Shims names linked reply block shims; see [ReplyBlockShims].
	Shims ReplyBlockShims

	// FileSystem is the file system implementation.
	FileSystem UnaryFileSystem

	// Logf, if non-nil, receives diagnostic messages. If nil, failures
	// to deliver a reply are reported through the log package and other
	// diagnostics are dropped.
	Logf func(format string, args ...any)
}

type SetAttributes struct {
	Mode       *uint32
	UID        *uint32
	GID        *uint32
	Flags      *uint32
	Size       *uint64
	AccessTime *syscall.Timespec
	ModifyTime *syscall.Timespec
}

type StatisticsVolume interface {
	Volume

	// Statistics returns the volume's statfs statistics.
	Statistics() fskit.FSStatFSResult
}

type SymlinkVolume interface {
	Volume

	// Readlink returns the target of the symbolic link item.
	Readlink(item Item) (string, error)

	// Symlink creates a symbolic link named name to target in dir.
	Symlink(dir Item, name, target string) (Item, error)
}

type UnaryFileSystem interface {
	// Probe inspects a resource and names the file system that would
	// mount it.
	Probe(resource fskit.FSResource) (ProbeResult, error)

	// Load prepares the resource and returns its volume.
	Load(resource fskit.FSResource) (Volume, error)

	// Unload releases the resource. It may be called more than once.
	Unload() error
}

type Volume interface {
	// VolumeName returns the volume's display name.
	VolumeName() string

	// Root returns the item for the root directory.
	Root() (Item, error)

	// Lookup resolves name within the directory dir.
	Lookup(dir Item, name string) (Item, error)

	// Reclaim releases any state held for item. The system is done with
	// the item; it may be reclaimed more than once.
	Reclaim(item Item)

	// Attributes returns the item's attributes, including its file ID.
	Attributes(item Item) (fskit.FSItemAttributes, error)

	// ReadDir lists the directory dir.
	ReadDir(dir Item) ([]DirEntry, error)

	// Read reads from file at offset into buf, returning the number of
	// bytes read. Reading past the end of the file returns 0, and io.EOF
	// is not an error.
	Read(file Item, offset int64, buf []byte) (int, error)
}

type XattrVolume interface {
	Volume

	// GetXattr returns the value of the extended attribute name on item.
	GetXattr(item Item, name string) ([]byte, error)

	// SetXattr sets the extended attribute name on item to data.
	SetXattr(item Item, name string, data []byte) error

	// RemoveXattr removes the extended attribute name from item.
	RemoveXattr(item Item, name string) error

	// ListXattr lists the extended attribute names on item.
	ListXattr(item Item) ([]string, error)
}