trait MiscDirectives extends AnyRef
- Grouped
- Alphabetic
- By Inheritance
- MiscDirectives
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
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 MiscDirectives toany2stringadd[MiscDirectives] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
- def ->[B](y: B): (MiscDirectives, B)
- Implicit
- This member is added by an implicit conversion from MiscDirectives toArrowAssoc[MiscDirectives] 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
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- def ensuring(cond: (MiscDirectives) => Boolean, msg: => Any): MiscDirectives
- Implicit
- This member is added by an implicit conversion from MiscDirectives toEnsuring[MiscDirectives] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: (MiscDirectives) => Boolean): MiscDirectives
- Implicit
- This member is added by an implicit conversion from MiscDirectives toEnsuring[MiscDirectives] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean, msg: => Any): MiscDirectives
- Implicit
- This member is added by an implicit conversion from MiscDirectives toEnsuring[MiscDirectives] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean): MiscDirectives
- Implicit
- This member is added by an implicit conversion from MiscDirectives toEnsuring[MiscDirectives] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def extractClientIP: Directive1[RemoteAddress]
Extracts the client's IP from either the X-Forwarded-For, Remote-Address, X-Real-IP header or pekko.http.scaladsl.model.AttributeKeys.remoteAddress attribute (in that order of priority).
- 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()
- def rejectEmptyResponse: Directive0
Converts responses with an empty entity into (empty) rejections.
Converts responses with an empty entity into (empty) rejections. This way you can, for example, have the marshalling of a None option be treated as if the request could not be matched.
- def requestEntityEmpty: Directive0
Rejects if the request entity is non-empty.
- def requestEntityPresent: Directive0
Rejects with a RequestEntityExpectedRejection if the request entity is empty.
Rejects with a RequestEntityExpectedRejection if the request entity is empty. Non-empty requests are passed on unchanged to the inner route.
- def selectPreferredLanguage(first: Language, more: Language*): Directive1[Language]
Inspects the request's
Accept-Languageheader and determines, which of the given language alternatives is preferred by the client.Inspects the request's
Accept-Languageheader and determines, which of the given language alternatives is preferred by the client. (See http://tools.ietf.org/html/rfc7231#section-5.3.5 for more details on the negotiation logic.) If there are several best language alternatives that the client has equal preference for (even if this preference is zero!) the order of the arguments is used as a tie breaker (First one wins). - final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- def validate(check: => Boolean, errorMsg: String): Directive0
Checks the given condition before running its inner route.
Checks the given condition before running its inner route. If the condition fails the route is rejected with a ValidationRejection.
- 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()
- def withSizeLimit(maxBytes: Long): Directive0
Fails the stream with pekko.http.scaladsl.model.EntityStreamSizeException if its request entity size exceeds given limit.
Fails the stream with pekko.http.scaladsl.model.EntityStreamSizeException if its request entity size exceeds given limit. Limit given as parameter overrides limit configured with
pekko.http.parsing.max-content-length.Beware that request entity size check is executed when entity is consumed.
- def withoutSizeLimit: Directive0
Disables the size limit (configured by
pekko.http.parsing.max-content-lengthby default) checking on the incoming HttpRequest entity.Disables the size limit (configured by
pekko.http.parsing.max-content-lengthby default) checking on the incoming HttpRequest entity. Can be useful when handling arbitrarily large data uploads in specific parts of your routes.- Note
Usage of
withoutSizeLimitis not recommended as it turns off the too large payload protection. Therefore, we highly encourage usingwithSizeLimitinstead, providing it with a value high enough to successfully handle the route in need of big entities.
Deprecated Value Members
- def formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from MiscDirectives toStringFormat[MiscDirectives] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @deprecated @inline()
- Deprecated
(Since version 2.12.16) Use
formatString.format(value)instead ofvalue.formatted(formatString), or use thef""string interpolator. In Java 15 and later,formattedresolves to the new method in String which has reversed parameters.
- def →[B](y: B): (MiscDirectives, B)
- Implicit
- This member is added by an implicit conversion from MiscDirectives toArrowAssoc[MiscDirectives] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Use
->instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.