Config

object Config extends FileServiceConfigCompanionCompat
Companion
class
trait FileServiceConfigCompanionCompat
trait Product
trait Mirror
class Object
trait Matchable
class Any

Type members

Inherited types

type MirroredElemLabels <: Tuple

The names of the product elements

The names of the product elements

Inherited from
Mirror
type MirroredLabel <: String

The name of the type

The name of the type

Inherited from
Mirror
Inherited from
FileServiceConfigCompanionCompat

Value members

Concrete methods

def apply[F[_]](systemPath: String, fs2PathCollector: () => F, pathPrefix: String, cacheStrategy: CacheStrategy[F], bufferSize: Int): Config[F]

Creates an instance of org.http4s.server.staticcontent.FileService configuration.

Creates an instance of org.http4s.server.staticcontent.FileService configuration.

Value Params
bufferSize

buffer size to use for internal read buffers

cacheStrategy

strategy to use for caching purposes. Default to no caching.

fs2PathCollector

function that performs the work of collecting the file or rendering the directory into a response.

pathPrefix

prefix of Uri from which content will be served

systemPath

path prefix to the folder from which content will be served

def apply[F[_] : Async](systemPath: String, pathPrefix: String, bufferSize: Int, cacheStrategy: CacheStrategy[F]): Config[F]

Deprecated methods

@deprecated("use FileService.Config(systemPath: String, fs2PathCollector: Fs2PathCollector[F], ...)", "0.23.8")
def apply[F[_]](systemPath: String, pathCollector: () => F, pathPrefix: String, bufferSize: Int, cacheStrategy: CacheStrategy[F]): Config[F]

Creates an instance of org.http4s.server.staticcontent.FileService configuration. A constructor that accepts PathCollector[F] for binary compatibility.

Creates an instance of org.http4s.server.staticcontent.FileService configuration. A constructor that accepts PathCollector[F] for binary compatibility.

Value Params
bufferSize

buffer size to use for internal read buffers

cacheStrategy

strategy to use for caching purposes. Default to no caching.

pathCollector

function that performs the work of collecting the file or rendering the directory into a response.

pathPrefix

prefix of Uri from which content will be served

systemPath

path prefix to the folder from which content will be served

Deprecated

Deprecated and Inherited methods

@deprecated("Config is no longer a case class. The Config.fromProduct method is provided for binary compatibility.", "0.23.8")
def fromProduct(p: Product): MirroredMonoType
Deprecated
Inherited from
FileServiceConfigCompanionCompat
@deprecated("Config is no longer a case class. The Config.unapply method is provided for binary compatibility.", "0.23.8")
def unapply[F[_]](config: Config[F]): Config[F]
Deprecated
Inherited from
FileServiceConfigCompanionCompat