Config

org.http4s.server.staticcontent.FileService.Config
See theConfig companion class
object Config

Attributes

Companion
class
Source
FileService.scala
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Config.type

Members list

Type members

Inherited types

type MirroredElemLabels <: Tuple

The names of the product elements

The names of the product elements

Attributes

Inherited from:
Mirror
Source
Mirror.scala

The name of the type

The name of the type

Attributes

Inherited from:
Mirror
Source
Mirror.scala
type MirroredMonoType = Config[_[_]]

The mirrored *-type

The mirrored *-type

Attributes

Inherited from:
FileServiceConfigCompanionCompat (hidden)
Source
FileServiceConfigCompat.scala

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 parameters

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

Attributes

Source
FileService.scala
def apply[F[_] : Files](systemPath: String, pathPrefix: String, bufferSize: Int, cacheStrategy: CacheStrategy[F]): Config[F]

Attributes

Source
FileService.scala

Deprecated methods

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.

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

Value parameters

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

Attributes

Deprecated
true
Source
FileService.scala
def apply[F[_]](systemPath: String, pathPrefix: String, bufferSize: Int, cacheStrategy: CacheStrategy[F], F: Async[F]): Config[F]

Attributes

Deprecated
true
Source
FileService.scala

Deprecated and Inherited methods

def fromProduct(p: Product): MirroredMonoType

Create a new instance of type T with elements taken from product p.

Create a new instance of type T with elements taken from product p.

Attributes

Deprecated
true
Inherited from:
FileServiceConfigCompanionCompat (hidden)
Source
FileServiceConfigCompat.scala
def unapply[F[_]](config: Config[F]): Config[F]

Attributes

Deprecated
true
Inherited from:
FileServiceConfigCompanionCompat (hidden)
Source
FileServiceConfigCompat.scala