org.http4s.server.staticcontent.FileService

Config

final case class Config(systemPath: String, pathPrefix: String = "", pathCollector: (File, Config, Request) ⇒ Task[Option[Response]] = filesOnly, bufferSize: Int = 50*1024, executor: ExecutorService = DefaultPool, 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
executor: ExecutorService to use when collecting content
cacheStrategy: strategy to use for caching purposes. Default to no caching.

Source: FileService.scala

Linear Supertypes

Serializable, Serializable, Product, Equals, AnyRef, Any

Ordering

Alphabetic
By Inheritance

Inherited

Config
Serializable
Serializable
Product
Equals
AnyRef
Any

Implicitly

by any2stringadd
by StringFormat
by Ensuring
by ArrowAssoc

Hide All
Show All

Visibility

Public
All

Instance Constructors

new Config(systemPath: String, pathPrefix: String = "", pathCollector: (File, Config, Request) ⇒ Task[Option[Response]] = filesOnly, bufferSize: Int = 50*1024, executor: ExecutorService = DefaultPool, cacheStrategy: CacheStrategy = NoopCacheStrategy)
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
executor
ExecutorService to use when collecting content
cacheStrategy
strategy to use for caching purposes. Default to no caching.

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
def +(other: String): String

Implicit
This member is added by an implicit conversion from Config to any2stringadd[Config] performed by method any2stringadd in scala.Predef.
Definition Classes
any2stringadd
def ->[B](y: B): (Config, B)

Implicit
This member is added by an implicit conversion from Config to ArrowAssoc[Config] performed by method ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc
Annotations
@inline()
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
val bufferSize: Int
val cacheStrategy: CacheStrategy
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def ensuring(cond: (Config) ⇒ Boolean, msg: ⇒ Any): Config

Implicit
This member is added by an implicit conversion from Config to Ensuring[Config] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: (Config) ⇒ Boolean): Config

Implicit
This member is added by an implicit conversion from Config to Ensuring[Config] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean, msg: ⇒ Any): Config

Implicit
This member is added by an implicit conversion from Config to Ensuring[Config] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean): Config

Implicit
This member is added by an implicit conversion from Config to Ensuring[Config] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
val executor: ExecutorService
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
def formatted(fmtstr: String): String

Implicit
This member is added by an implicit conversion from Config to StringFormat[Config] performed by method StringFormat in scala.Predef.
Definition Classes
StringFormat
Annotations
@inline()
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val pathCollector: (File, Config, Request) ⇒ Task[Option[Response]]
val pathPrefix: String
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
val systemPath: String
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
def →[B](y: B): (Config, B)

Implicit
This member is added by an implicit conversion from Config to ArrowAssoc[Config] performed by method ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc

Inherited from AnyRef

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 clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Inherited from Any

Value Members

final def asInstanceOf[T0]: T0

Definition Classes
Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any

Inherited by implicit conversion any2stringadd from Config to any2stringadd[Config]

Value Members

def +(other: String): String

Implicit
This member is added by an implicit conversion from Config to any2stringadd[Config] performed by method any2stringadd in scala.Predef.
Definition Classes
any2stringadd

Inherited by implicit conversion StringFormat from Config to StringFormat[Config]

Value Members

def formatted(fmtstr: String): String

Implicit
This member is added by an implicit conversion from Config to StringFormat[Config] performed by method StringFormat in scala.Predef.
Definition Classes
StringFormat
Annotations
@inline()

Inherited by implicit conversion Ensuring from Config to Ensuring[Config]

Value Members

def ensuring(cond: (Config) ⇒ Boolean, msg: ⇒ Any): Config

Implicit
This member is added by an implicit conversion from Config to Ensuring[Config] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: (Config) ⇒ Boolean): Config

Implicit
This member is added by an implicit conversion from Config to Ensuring[Config] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean, msg: ⇒ Any): Config

Implicit
This member is added by an implicit conversion from Config to Ensuring[Config] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean): Config

Implicit
This member is added by an implicit conversion from Config to Ensuring[Config] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring

Inherited by implicit conversion ArrowAssoc from Config to ArrowAssoc[Config]

Value Members

def ->[B](y: B): (Config, B)

Implicit
This member is added by an implicit conversion from Config to ArrowAssoc[Config] performed by method ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc
Annotations
@inline()
def →[B](y: B): (Config, B)

Implicit
This member is added by an implicit conversion from Config to ArrowAssoc[Config] performed by method ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc

Ungrouped

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
def +(other: String): String

Implicit
This member is added by an implicit conversion from Config to any2stringadd[Config] performed by method any2stringadd in scala.Predef.
Definition Classes
any2stringadd
def ->[B](y: B): (Config, B)

Implicit
This member is added by an implicit conversion from Config to ArrowAssoc[Config] performed by method ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc
Annotations
@inline()
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
val bufferSize: Int
val cacheStrategy: CacheStrategy
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def ensuring(cond: (Config) ⇒ Boolean, msg: ⇒ Any): Config

Implicit
This member is added by an implicit conversion from Config to Ensuring[Config] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: (Config) ⇒ Boolean): Config

Implicit
This member is added by an implicit conversion from Config to Ensuring[Config] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean, msg: ⇒ Any): Config

Implicit
This member is added by an implicit conversion from Config to Ensuring[Config] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean): Config

Implicit
This member is added by an implicit conversion from Config to Ensuring[Config] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
val executor: ExecutorService
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
def formatted(fmtstr: String): String

Implicit
This member is added by an implicit conversion from Config to StringFormat[Config] performed by method StringFormat in scala.Predef.
Definition Classes
StringFormat
Annotations
@inline()
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val pathCollector: (File, Config, Request) ⇒ Task[Option[Response]]
val pathPrefix: String
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
val systemPath: String
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
def →[B](y: B): (Config, B)

Implicit
This member is added by an implicit conversion from Config to ArrowAssoc[Config] performed by method ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc

Packages

Config 

final case class Config(systemPath: String, pathPrefix: String = "", pathCollector: (File, Config, Request) ⇒ Task[Option[Response]] = filesOnly, bufferSize: Int = 50*1024, executor: ExecutorService = DefaultPool, cacheStrategy: CacheStrategy = NoopCacheStrategy) extends Product with Serializable

Instance Constructors

Value Members

Inherited from AnyRef

Value Members

Inherited from Any

Value Members

Inherited by implicit conversion any2stringadd from Config to any2stringadd[Config]

Value Members

Inherited by implicit conversion StringFormat from Config to StringFormat[Config]

Value Members

Inherited by implicit conversion Ensuring from Config to Ensuring[Config]

Value Members

Inherited by implicit conversion ArrowAssoc from Config to ArrowAssoc[Config]

Value Members

Ungrouped

Config