server
0.23.24
API
Generated with
server/org.http4s.server/org.http4s.server.staticcontent/FileService/Config

Config

org.http4s.server.staticcontent.FileService.Config
See theConfig companion object
final class Config[F[_]](val systemPath: String, val fs2PathCollector: () => F, val pathPrefix: String, val cacheStrategy: CacheStrategy[F], val bufferSize: Int) extends Product, Serializable, Equals

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

Companion
object
Source
FileService.scala
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all

Members list

Value members

Deprecated constructors

def this(systemPath: String, pathCollector: () => F, pathPrefix: String, bufferSize: Int, cacheStrategy: CacheStrategy[F])

For binary compatibility.

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

Concrete methods

override def canEqual(that: Any): Boolean

Attributes

Definition Classes
Source
FileService.scala
override def equals(other: Any): Boolean

Compares the receiver object (this) with the argument object (that) for equivalence.

Compares the receiver object (this) with the argument object (that) for equivalence.

Any implementation of this method should be an equivalence relation:

- It is reflexive: for any instance x of type Any, x.equals(x) should return true. - It is symmetric: for any instances x and y of type Any, x.equals(y) should return true if and only if y.equals(x) returns true. - It is transitive: for any instances x, y, and z of type Any if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.

If you override this method, you should verify that your implementation remains an equivalence relation. Additionally, when overriding this method it is usually necessary to override hashCode to ensure that objects which are "equal" (o1.equals(o2) returns true) hash to the same scala.Int. (o1.hashCode.equals(o2.hashCode)).

Value parameters

that

the object to compare against this object for equality.

Attributes

Returns

true if the receiver object is equivalent to the argument; false otherwise.

Definition Classes
Equals -> Any
Source
FileService.scala
override def hashCode(): Int

Calculate a hash code value for the object.

Calculate a hash code value for the object.

The default hashing algorithm is platform dependent.

Note that it is allowed for two objects to have identical hash codes (o1.hashCode.equals(o2.hashCode)) yet not be equal (o1.equals(o2) returns false). A degenerate implementation could always return 0. However, it is required that if two objects are equal (o1.equals(o2) returns true) that they have identical hash codes (o1.hashCode.equals(o2.hashCode)). Therefore, when overriding this method, be sure to verify that the behavior is consistent with the equals method.

Attributes

Returns

the hash code value for this object.

Definition Classes
Any
Source
FileService.scala
override def toString: String

Returns a string representation of the object.

Returns a string representation of the object.

The default representation is platform dependent.

Attributes

Returns

a string representation of the object.

Definition Classes
Any
Source
FileService.scala

Deprecated methods

def _1: String

Attributes

Deprecated
true
Source
FileService.scala
def _2: (, , ) =>

Attributes

Deprecated
true
Source
FileService.scala
def _3: String

Attributes

Deprecated
true
Source
FileService.scala
def _4: Int

Attributes

Deprecated
true
Source
FileService.scala
def _5: CacheStrategy[F]

Attributes

Deprecated
true
Source
FileService.scala
def copy(systemPath: String, pathCollector: () => F, pathPrefix: String, bufferSize: Int, cacheStrategy: CacheStrategy[F]): Config[F]

Attributes

Deprecated
true
Source
FileService.scala
def pathCollector: () => F

For binary compatibility.

For binary compatibility.

Attributes

Returns

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

Deprecated
true
Source
FileService.scala
override def productArity: Int

Attributes

Deprecated
true
Definition Classes
Source
FileService.scala
override def productElement(n: Int): Any

Attributes

Deprecated
true
Definition Classes
Source
FileService.scala

Inherited methods

def productElementName(n: Int): String

Attributes

Inherited from:
Product
def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product
def productPrefix: String

Attributes

Inherited from:
Product

Concrete fields

val bufferSize: Int

Attributes

Source
FileService.scala
val cacheStrategy: CacheStrategy[F]

Attributes

Source
FileService.scala
val fs2PathCollector: () => F

Attributes

Source
FileService.scala
val pathPrefix: String

Attributes

Source
FileService.scala
val systemPath: String

Attributes

Source
FileService.scala
Generated with