object Config extends FileServiceConfigCompanionCompat with Serializable
- Source
- FileService.scala
- Alphabetic
- By Inheritance
- Config
- Serializable
- FileServiceConfigCompanionCompat
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def apply[F[_]](systemPath: String, pathPrefix: String = "", bufferSize: Int = 50 * 1024, cacheStrategy: CacheStrategy[F] = NoopCacheStrategy[F])(implicit arg0: Async[F], arg1: Files[F]): Config[F]
- def apply[F[_]](systemPath: String, fs2PathCollector: 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.
- systemPath
path prefix to the folder from which content will be served
- 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
- cacheStrategy
strategy to use for caching purposes. Default to no caching.
- bufferSize
buffer size to use for internal read buffers
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
Deprecated Value Members
- def apply[F[_]](systemPath: String, pathPrefix: String, bufferSize: Int, cacheStrategy: CacheStrategy[F], F: Async[F]): Config[F]
- Annotations
- @deprecated
- Deprecated
(Since version 0.23.19) Use overload with Files constraint
- def apply[F[_]](systemPath: String, pathCollector: 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.
- systemPath
path prefix to the folder from which content will be served
- 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
- bufferSize
buffer size to use for internal read buffers
- cacheStrategy
strategy to use for caching purposes. Default to no caching.
- Annotations
- @deprecated
- Deprecated
(Since version 0.23.8) use FileService.Config(systemPath: String, fs2PathCollector: Fs2PathCollector[F], ...)
- def unapply[F[_]](config: Config[F]): Option[(String, PathCollector[F], String, Int, CacheStrategy[F])]
- Definition Classes
- FileServiceConfigCompanionCompat
- Annotations
- @deprecated
- Deprecated
(Since version 0.23.8) Config is no longer a case class. The Config.unapply method is provided for binary compatibility.