ktor-revfile-core/io.github.janmalch.ktor.revfile

Package-level declarations

Types

ReadableRevFileRegistry

interface ReadableRevFileRegistry : Iterable<RevisionedFile>

Read access for a revisioned file registry.

RevFileConfig

data class RevFileConfig

Configuration options for the RevFilePlugin.

RevFileRegistry

abstract class RevFileRegistry(path: String) : WriteableRevFileRegistry

A registry for revisioned files, scoped under the given path.

RevisionedFile

class RevisionedFile

Describes a revisioned file, meaning its path is unique based on its content.

WriteableRevFileRegistry

interface WriteableRevFileRegistry : ReadableRevFileRegistry

Write access for a revisioned file registry.

Properties

RevFilePlugin

val RevFilePlugin: ApplicationPlugin<RevFileConfig>

A Ktor server plugin for automatically revisioning files based on their content.

Functions

create

fun WriteableRevFileRegistry.create(originalName: String, contentType: ContentType = ContentType.defaultForFilePath(originalName), content: () -> OutgoingContent.ReadChannelContent): RevisionedFile

Creates a new custom RevisionedFile and adds it to this WriteableRevFileRegistry.

file

fun WriteableRevFileRegistry.file(file: File, contentType: ContentType = ContentType.defaultForFile(file), name: String = file.name): RevisionedFile

Creates a new RevisionedFile from the given file and adds it to this WriteableRevFileRegistry.

resource

fun WriteableRevFileRegistry.resource(resource: String, name: String = resource.substringAfterLast('/'), contentType: ContentType = ContentType.defaultForFilePath(resource), classLoader: ClassLoader = checkNotNull(this::class.java.classLoader) { "Failed to get a class loader for loading resource '$resource'." }): RevisionedFile

Creates a new RevisionedFile from the given JVM resource and adds it to this WriteableRevFileRegistry.

source

fun WriteableRevFileRegistry.source(originalName: String, contentType: ContentType = ContentType.defaultForFilePath(originalName), content: () -> Source): RevisionedFile

fun WriteableRevFileRegistry.source(path: Path, contentType: ContentType = ContentType.defaultForFilePath(path.toString()), originalName: String = path.name, fileSystem: FileSystem = SystemFileSystem): RevisionedFile

Creates a new RevisionedFile from the given source and adds it to this WriteableRevFileRegistry.

uri

fun WriteableRevFileRegistry.uri(uri: URI, name: String = uri.toString().substringAfterLast('/'), contentType: ContentType = ContentType.defaultForFilePath(uri.path)): RevisionedFile

Creates a new RevisionedFile from the given URI and adds it to this WriteableRevFileRegistry.

url

fun WriteableRevFileRegistry.url(url: URL, name: String = url.toString().substringAfterLast('/'), contentType: ContentType = ContentType.defaultForFilePath(url.path)): RevisionedFile

Creates a new RevisionedFile from the given URL and adds it to this WriteableRevFileRegistry.