smithy4s.http
Members list
Packages
Type members
Classlikes
Attributes
- Companion
- object
- Supertypes
-
trait Serializabletrait Ordered[CaseInsensitive]trait Comparable[CaseInsensitive]class Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Supertypes
-
class Objecttrait Matchableclass Any
- Self type
-
CaseInsensitive.type
Attributes
- Companion
- object
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
- Known subtypes
-
class HeaderBindingclass HeaderPrefixBindingclass PathBindingclass QueryBindingobject QueryParamsBinding.typeobject StatusCodeBinding.typeShow all
Attributes
- Companion
- class
- Supertypes
-
trait Sumtrait Mirrortrait Companion[HttpBinding]trait Has[HttpBinding]trait ShapeTag[HttpBinding]trait HasIdclass Objecttrait Matchableclass AnyShow all
- Self type
-
HttpBinding.type
Attributes
- Companion
- object
- Supertypes
-
trait NoStackTraceclass Throwabletrait Serializableclass Objecttrait Matchableclass AnyShow all
- Known subtypes
-
class HttpPayloadErrortrait MetadataErrorclass ArityErrorclass FailedConstraintclass ImpossibleDecodingclass NotFoundclass WrongTypeShow all
Attributes
- Companion
- trait
- Supertypes
-
trait Sumtrait Mirrorclass Objecttrait Matchableclass Any
- Self type
-
HttpContractError.type
Attributes
- Companion
- object
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
- Known subtypes
Attributes
- Companion
- trait
- Supertypes
-
trait Sumtrait Mirrorclass Objecttrait Matchableclass Any
- Self type
-
HttpDiscriminator.type
Attributes
- Companion
- object
- Supertypes
-
class Objecttrait Matchableclass Any
Attributes
- Companion
- trait
- Supertypes
-
class Objecttrait Matchableclass Any
- Self type
-
HttpEndpoint.type
Utility function to help find the decoder matching a certain discriminator This is useful when deserializing on the client side of a request/response round trip.
Utility function to help find the decoder matching a certain discriminator This is useful when deserializing on the client side of a request/response round trip.
Attributes
- Supertypes
-
class Objecttrait Matchableclass Any
- Self type
-
HttpErrorSelector.type
Attributes
- Supertypes
-
class Objecttrait Matchableclass Any
- Self type
-
HttpHostPrefix.type
Attributes
- Supertypes
- Self type
-
HttpMediaType.type
Attributes
- Companion
- trait
- Supertypes
-
trait Sumtrait Mirrorclass Objecttrait Matchableclass Any
- Self type
-
HttpMethod.type
Attributes
- Companion
- object
- Supertypes
-
trait Producttrait Equalstrait HttpContractErrortrait NoStackTraceclass Throwabletrait Serializableclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Supertypes
-
trait Producttrait Mirrorclass Objecttrait Matchableclass Any
- Self type
-
HttpPayloadError.type
Attributes
- Companion
- object
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Supertypes
-
trait Producttrait Mirrorclass Objecttrait Matchableclass Any
- Self type
-
HttpRequest.type
Attributes
- Companion
- object
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Supertypes
-
trait Producttrait Mirrorclass Objecttrait Matchableclass Any
- Self type
-
HttpResponse.type
This construct indicates how a schema is split between http metadata (ie headers, path parameters, query parameters, status code) and body.
This construct indicates how a schema is split between http metadata (ie headers, path parameters, query parameters, status code) and body.
When the input or the output of an http operation has some elements that are coming from the body and some elements that are coming from the metadata, the schema is split in two schemas that each track the relevant subset.
The partial data resulting from the successful decoding of both subsets can be reconciled to recover the total data.
On the encoding side, the split allows to only encode the relevant subset of data as http headers, and the other subset as http body.
Attributes
- Companion
- object
- Supertypes
-
class Objecttrait Matchableclass Any
- Known subtypes
Attributes
- Companion
- trait
- Supertypes
-
trait Sumtrait Mirrorclass Objecttrait Matchableclass Any
- Self type
-
HttpRestSchema.type
Typeclass construct allowing to retrieve the status code associated to a value.
Typeclass construct allowing to retrieve the status code associated to a value.
Attributes
- Companion
- object
- Supertypes
-
class Objecttrait Matchableclass Any
Attributes
- Companion
- trait
- Supertypes
- Self type
-
HttpStatusCode.type
Attributes
- Supertypes
-
class Objecttrait Matchableclass Any
- Self type
Attributes
- Supertypes
-
class Objecttrait Matchableclass Any
- Self type
Attributes
- Supertypes
-
class Objecttrait Matchableclass Any
- Self type
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- trait
- Supertypes
-
trait Sumtrait Mirrorclass Objecttrait Matchableclass Any
- Self type
-
HttpUriScheme.type
Datatype containing metadata associated to a http message.
Datatype containing metadata associated to a http message.
The metadata is what is found in the http headers, and can be derived from the http path, the query parameters, or the headers.
Associated to it are a pair of Encoder/Decoder typeclasses, that can be derived from a schema.
Value parameters
- headers
-
the header parameters of the http message
- path
-
the path parameters of the http message
- query
-
the query parameters of the http message
Attributes
- Companion
- object
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
- Self type
Attributes
- Companion
- object
- Supertypes
-
trait HttpContractErrortrait NoStackTraceclass Throwabletrait Serializableclass Objecttrait Matchableclass AnyShow all
- Known subtypes
Attributes
- Companion
- trait
- Supertypes
-
trait Sumtrait Mirrorclass Objecttrait Matchableclass Any
- Self type
-
MetadataError.type
Attributes
- Companion
- object
- Supertypes
-
class Objecttrait Matchableclass Any
- Known subtypes
Attributes
- Companion
- trait
- Supertypes
-
trait Sumtrait Mirrorclass Objecttrait Matchableclass Any
- Self type
-
PathSegment.type
Attributes
- Supertypes
-
trait Producttrait Equalsclass Throwabletrait Serializableclass Objecttrait Matchableclass AnyShow all
Represents data that was encoded using the application/x-www-form-urlencoded
format.
Represents data that was encoded using the application/x-www-form-urlencoded
format.
Attributes
- Companion
- object
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Supertypes
-
trait Producttrait Equalsclass Throwabletrait Serializableclass Objecttrait Matchableclass AnyShow all
Types
Value members
Concrete methods
Returns the first http endpoint that matches both a method and path, as well as the map of extracted segment values.
Returns the first http endpoint that matches both a method and path, as well as the map of extracted segment values.