Class

org.http4s.server.staticcontent.FileService

Config

Related Doc: package FileService

Permalink

final case class Config(systemPath: String, pathPrefix: String = "", pathCollector: (File, Config, Request) ⇒ OptionT[Task, Response] = filesOnly, bufferSize: Int = 50*1024, executionContext: ExecutionContext = ExecutionContext.global, cacheStrategy: CacheStrategy = NoopCacheStrategy) extends Product with Serializable

org.http4s.server.staticcontent.FileService configuration

systemPath

path prefix to the folder from which content will be served

pathPrefix

prefix of Uri from which content will be served

pathCollector

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

bufferSize

buffer size to use for internal read buffers

executionContext

ExecutionContext to use when collecting content

cacheStrategy

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

Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Config
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Config(systemPath: String, pathPrefix: String = "", pathCollector: (File, Config, Request) ⇒ OptionT[Task, Response] = filesOnly, bufferSize: Int = 50*1024, executionContext: ExecutionContext = ExecutionContext.global, cacheStrategy: CacheStrategy = NoopCacheStrategy)

    Permalink

    systemPath

    path prefix to the folder from which content will be served

    pathPrefix

    prefix of Uri from which content will be served

    pathCollector

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

    bufferSize

    buffer size to use for internal read buffers

    executionContext

    ExecutionContext to use when collecting content

    cacheStrategy

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

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  5. val bufferSize: Int

    Permalink

    buffer size to use for internal read buffers

  6. val cacheStrategy: CacheStrategy

    Permalink

    strategy to use for caching purposes.

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

  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  8. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  9. val executionContext: ExecutionContext

    Permalink

    ExecutionContext to use when collecting content

  10. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  11. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  12. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  13. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  14. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  15. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  16. val pathCollector: (File, Config, Request) ⇒ OptionT[Task, Response]

    Permalink

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

  17. val pathPrefix: String

    Permalink

    prefix of Uri from which content will be served

  18. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  19. val systemPath: String

    Permalink

    path prefix to the folder from which content will be served

  20. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  21. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  22. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped