server/org.http4s.server.staticcontent/FileService/Config

Config

final
class Config[F[_]](val systemPath: String, val fs2PathCollector: () => F, val pathPrefix: String, val cacheStrategy: CacheStrategy[F], val bufferSize: Int) extends Product with Serializable with Equals

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

Companion
object
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any

Value members

Deprecated constructors

@deprecated("use the constructor with fs2PathCollector", "0.23.8")
def this(systemPath: String, pathCollector: () => F, pathPrefix: String, bufferSize: Int, cacheStrategy: CacheStrategy[F])

For binary compatibility.

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

Concrete methods

override
def canEqual(that: Any): Boolean
Definition Classes
Equals
override
def equals(other: Any): Boolean
Definition Classes
Equals -> Any
override
def hashCode(): Int
Definition Classes
Any
override
def toString: String
Definition Classes
Any

Deprecated methods

@deprecated("Config is no longer a case class. The _1 method is provided for binary compatibility.", "0.23.8")
def _1: String
Deprecated
@deprecated("Config is no longer a case class. The _2 method is provided for binary compatibility.", "0.23.8")
def _2: (, , ) =>
Deprecated
@deprecated("Config is no longer a case class. The _3 method is provided for binary compatibility.", "0.23.8")
def _3: String
Deprecated
@deprecated("Config is no longer a case class. The _4 method is provided for binary compatibility.", "0.23.8")
def _4: Int
Deprecated
@deprecated("Config is no longer a case class. The _5 method is provided for binary compatibility.", "0.23.8")
def _5: CacheStrategy[F]
Deprecated
@deprecated("Config is no longer a case class. The copy method is provided for binary compatibility.", "0.23.8")
def copy(systemPath: String, @nowarn pathCollector: () => F, pathPrefix: String, bufferSize: Int, cacheStrategy: CacheStrategy[F]): Config[F]
Deprecated
@deprecated("use fs2PathCollector", "0.23.8")
def pathCollector: () => F

For binary compatibility.

For binary compatibility.

Returns

an instance of PathCollector[F] created (converted) from fs2PathCollector

Deprecated
@deprecated("Config is no longer a case class. The productArity method is provided for binary compatibility.", "0.23.8")
override
def productArity: Int
Deprecated
Definition Classes
Product
@deprecated("Config is no longer a case class. The productElement method is provided for binary compatibility.", "0.23.8")
override
def productElement(n: Int): Any
Deprecated
Definition Classes
Product

Inherited methods

def productElementName(n: Int): String
Inherited from
Product
def productElementNames: Iterator[String]
Inherited from
Product
def productIterator: Iterator[Any]
Inherited from
Product
def productPrefix: String
Inherited from
Product

Concrete fields

val bufferSize: Int
val fs2PathCollector: () => F
val pathPrefix: String
val systemPath: String