Index

Modules: flysystem, flysystem/core, flysystem/filesystem, flysystem/local, flysystem/policy.

API symbols

abstract:

• core: macro abstract(x: untyped): untyped

addDisk:

• filesystem: proc addDisk(fs: Filesystem; name: string; driver: StorageDriver)
• filesystem: proc addDisk(fs: Filesystem; name: string; driver: StorageDriver; policy: PolicyRules)

append:

• core: method append(d: StorageDriver; path, content: string)
• local: method append(d: LocalDriver; path, content: string)
• policy: method append(p: FilesystemPolicy; path, content: string)

appendStream:

• core: method appendStream(d: StorageDriver; path: string; src: File)
• local: method appendStream(d: LocalDriver; path: string; src: File)
• policy: method appendStream(p: FilesystemPolicy; path: string; src: File)

checksum:

• core: method checksum(d: StorageDriver; path: string): string
• local: method checksum(d: LocalDriver; path: string): string
• policy: method checksum(p: FilesystemPolicy; path: string): string

chmod:

• local: method chmod(d: LocalDriver; path: string; mode: int)

chown:

• local: method chown(d: LocalDriver; path: string; uid, gid: int)

copy:

• core: method copy(d: StorageDriver; src, dest: string)
• local: method copy(d: LocalDriver; src, dest: string)
• policy: method copy(p: FilesystemPolicy; src, dest: string)

copyDir:

• core: method copyDir(d: StorageDriver; src, dest: string)
• local: method copyDir(d: LocalDriver; src, dest: string)
• policy: method copyDir(p: FilesystemPolicy; src, dest: string)

createSymlink:

• local: method createSymlink(d: LocalDriver; path, target: string)

defaultPolicyRules:

• policy: proc defaultPolicyRules(): PolicyRules

delete:

• core: method delete(d: StorageDriver; path: string)
• filesystem: proc delete(fs: Filesystem; path: string)
• local: method delete(d: LocalDriver; path: string)
• policy: method delete(p: FilesystemPolicy; path: string)

deleteDir:

• core: method deleteDir(d: StorageDriver; path: string; force = false)
• local: method deleteDir(d: LocalDriver; path: string; force = false)
• policy: method deleteDir(p: FilesystemPolicy; path: string; force = false)

disk:

• filesystem: proc disk(fs: Filesystem; name = ""): StorageDriver

diskPolicy:

• filesystem: proc diskPolicy(fs: Filesystem; name = ""): PolicyRules

diskUsage:

• local: method diskUsage(d: LocalDriver): tuple[total, free, used: int64]

exists:

• core: method exists(d: StorageDriver; path: string): bool
• filesystem: proc exists(fs: Filesystem; path: string): bool
• local: method exists(d: LocalDriver; path: string): bool
• policy: method exists(p: FilesystemPolicy; path: string): bool

FileMetadata:

• core: object FileMetadata

Filesystem:

• filesystem: type Filesystem

FilesystemPolicy:

• policy: type FilesystemPolicy

inner:

• policy: proc inner(p: FilesystemPolicy): StorageDriver

isSymlink:

• local: method isSymlink(d: LocalDriver; path: string): bool

lastModified:

• core: method lastModified(d: StorageDriver; path: string): Time
• local: method lastModified(d: LocalDriver; path: string): times.Time
• policy: method lastModified(p: FilesystemPolicy; path: string): Time

list:

• core: method list(d: StorageDriver; path: string; recursive = false): seq[FileMetadata]
• local: method list(d: LocalDriver; path: string; recursive = false): seq[FileMetadata]
• policy: method list(p: FilesystemPolicy; path: string; recursive = false): seq[FileMetadata]

LocalDriver:

• core: type LocalDriver

makeDir:

• core: method makeDir(d: StorageDriver; path: string)
• local: method makeDir(d: LocalDriver; path: string)
• policy: method makeDir(p: FilesystemPolicy; path: string)

metadata:

• core: method metadata(d: StorageDriver; path: string): FileMetadata
• local: method metadata(d: LocalDriver; path: string): FileMetadata
• policy: method metadata(p: FilesystemPolicy; path: string): FileMetadata

mimeType:

• core: method mimeType(d: StorageDriver; path: string): string
• local: method mimeType(d: LocalDriver; path: string): string
• policy: method mimeType(p: FilesystemPolicy; path: string): string

move:

• core: method move(d: StorageDriver; src, dest: string)
• local: method move(d: LocalDriver; src, dest: string)
• policy: method move(p: FilesystemPolicy; src, dest: string)

moveDir:

• core: method moveDir(d: StorageDriver; src, dest: string)
• local: method moveDir(d: LocalDriver; src, dest: string)
• policy: method moveDir(p: FilesystemPolicy; src, dest: string)

newFilesystem:

• filesystem: proc newFilesystem(defaultDisk = "local"): Filesystem

newFilesystemPolicy:

• policy: proc newFilesystemPolicy(inner: StorageDriver; rules: PolicyRules = defaultPolicyRules()): FilesystemPolicy

newLocalDriver:

• local: proc newLocalDriver(root: string): LocalDriver

parseCsv:

• filesystem: template parseCsv(fs: Filesystem; path: string)

parseJson:

• filesystem: template parseJson(fs: Filesystem; path: string): untyped
• filesystem: template parseJson[T](fs: Filesystem; path: string; t: typedesc[T]): untyped

parseToml:

• filesystem: template parseToml(fs: Filesystem; path: string): untyped

parseYaml:

• filesystem: template parseYaml(fs: Filesystem; path: string): untyped
• filesystem: template parseYaml[T](fs: Filesystem; path: string; t: typedesc[T]): untyped

PolicyError:

• policy: object PolicyError

PolicyRules:

• policy: object PolicyRules

rawDisk:

• filesystem: proc rawDisk(fs: Filesystem; name = ""): StorageDriver

read:

• core: method read(d: StorageDriver; path: string): string
• filesystem: proc read(fs: Filesystem; path: string): string
• local: method read(d: LocalDriver; path: string): string
• policy: method read(p: FilesystemPolicy; path: string): string

readLines:

• local: iterator readLines(d: LocalDriver; path: string): string

readLink:

• local: method readLink(d: LocalDriver; path: string): string

readStream:

• core: method readStream(d: StorageDriver; path: string): MemFile
• local: method readStream(d: LocalDriver; path: string): MemFile
• policy: method readStream(p: FilesystemPolicy; path: string): MemFile

rules:

• policy: proc rules(p: FilesystemPolicy): PolicyRules

search:

• core: method search(d: StorageDriver; pattern: string): seq[string]
• local: method search(d: LocalDriver; pattern: string): seq[string]
• policy: method search(p: FilesystemPolicy; pattern: string): seq[string]

setVisibility:

• core: method setVisibility(d: StorageDriver; path: string; visibility: Visibility)
• local: method setVisibility(d: LocalDriver; path: string; visibility: Visibility)
• policy: method setVisibility(p: FilesystemPolicy; path: string; visibility: Visibility)

size:

• core: method size(d: StorageDriver; path: string): int64
• local: method size(d: LocalDriver; path: string): int64
• policy: method size(p: FilesystemPolicy; path: string): int64

StorageDriver:

• core: type StorageDriver

StorageError:

• core: object StorageError

touch:

• core: method touch(d: StorageDriver; path: string)
• local: method touch(d: LocalDriver; path: string)
• policy: method touch(p: FilesystemPolicy; path: string)

Visibility:

• core: enum Visibility

visibility:

• core: method visibility(d: StorageDriver; path: string): Visibility
• local: method visibility(d: LocalDriver; path: string): Visibility
• policy: method visibility(p: FilesystemPolicy; path: string): Visibility

visPrivate:

• core: Visibility.visPrivate

visPublic:

• core: Visibility.visPublic

withLock:

• local: template withLock(d: LocalDriver; path: string; body: untyped)

write:

• core: method write(d: StorageDriver; path, content: string; visibility = visPrivate)
• filesystem: proc write(fs: Filesystem; path, content: string; visibility = visPrivate)
• local: method write(d: LocalDriver; path, content: string; visibility = visPrivate)
• policy: method write(p: FilesystemPolicy; path, content: string; visibility = visPrivate)

writeStream:

• core: method writeStream(d: StorageDriver; path: string; src: File)
• local: method writeStream(d: LocalDriver; path: string; src: File)
• policy: method writeStream(p: FilesystemPolicy; path: string; src: File)