Trait/Object

akka.http.scaladsl.server.directives

MiscDirectives

Related Docs: object MiscDirectives | package directives

Permalink

trait MiscDirectives extends AnyRef

Source
MiscDirectives.scala
Linear Supertypes
AnyRef, Any
Known Subclasses
Type Hierarchy
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. MiscDirectives
  2. AnyRef
  3. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

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

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

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

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

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

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

    Permalink
    Definition Classes
    Any
  7. def clone(): AnyRef

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

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

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

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

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

    Permalink
    Definition Classes
    AnyRef
  13. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  14. def extractClientIP: Directive1[RemoteAddress]

    Permalink

    Extracts the client's IP from either the X-Forwarded-For, Remote-Address or X-Real-IP header (in that order of priority).

  15. def finalize(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  18. def hashCode(): Int

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

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

    Permalink
    Definition Classes
    AnyRef
  21. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  22. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  23. def rejectEmptyResponse: Directive0

    Permalink

    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.

  24. def requestEntityEmpty: Directive0

    Permalink

    Rejects if the request entity is non-empty.

  25. def requestEntityPresent: Directive0

    Permalink

    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.

  26. def selectPreferredLanguage(first: Language, more: Language*): Directive1[Language]

    Permalink

    Inspects the request's Accept-Language header and determines, which of the given language alternatives is preferred by the client.

    Inspects the request's Accept-Language header 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).

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

    Permalink
    Definition Classes
    AnyRef
  28. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  29. def validate(check: ⇒ Boolean, errorMsg: String): Directive0

    Permalink

    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.

  30. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  33. def withSizeLimit(maxBytes: Long): Directive0

    Permalink

    Fails the stream with akka.http.scaladsl.model.EntityStreamSizeException if its request entity size exceeds given limit.

    Fails the stream with akka.http.scaladsl.model.EntityStreamSizeException if its request entity size exceeds given limit. Limit given as parameter overrides limit configured with akka.http.parsing.max-content-length.

    Beware that request entity size check is executed when entity is consumed.

  34. def withoutSizeLimit: Directive0

    Permalink

    Disables the size limit (configured by akka.http.parsing.max-content-length by default) checking on the incoming HttpRequest entity.

    Disables the size limit (configured by akka.http.parsing.max-content-length by 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 withoutSizeLimit is not recommended as it turns off the too large payload protection. Therefore, we highly encourage using withSizeLimit instead, providing it with a value high enough to successfully handle the route in need of big entities.

  35. def [B](y: B): (MiscDirectives, B)

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

Inherited from AnyRef

Inherited from Any

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

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

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

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

Miscellaneous directives

Ungrouped