Structures

A set of values representing the format of a response body.

This struct is intended to be “enum-like” and values should be accessed via the public static stored properties.

Usage Example:

let format = BodyFormat.json

An error that may be thrown when a particular instance of BodyFormat is not supported.

An error representing a failed request. This definition is intended to be used by both the client side (e.g. KituraKit) and server side (e.g. Kitura) of the request (typically a HTTP REST request).

Usage Example:

In this example, the RequestError is used in a Kitura server Codable route handler to indicate the request has failed because the requested record was not found.

router.get("/users") { (id: Int, respondWith: (User?, RequestError?) -> Void) in
    ...
    respondWith(nil, RequestError.notFound)
    ...
}

A codable struct containing the ordering information

Usage Example:

To order ascending by name and descending by age, we would write:

   Ordering(by: .asc("name"), .desc("age"))

A codable struct containing the pagination information

Usage Example:

To get only the first 10 values, we would write:

Pagination(size: 10)

To get the 11th to 20th values, we would write:

Pagination(start: 10, size: 10)

A codable struct enabling greater than filtering

Usage Example:

To filter with greaterThan on age which is an Integer, we would write:

struct MyQuery: QueryParams {
  let age: GreaterThan<Int>
}
let query = MyQuery(age: GreaterThan(value: 8))

In a URL it would translate to:

?age=8

Note: The “age=8” format is not an API but an implementation detail that could change in the future.

A codable struct enabling greater than or equal filtering

Usage Example:

To filter with greater than or equal on age which is an Integer, we would write:

struct MyQuery: QueryParams {
  let age: GreaterThanOrEqual<Int>
}
let query = MyQuery(age: GreaterThanOrEqual>(value: 8))

In a URL it would translate to:

?age=8

Note: The “age=8” format is not an API but an implementation detail that could change in the future.

A codable struct enabling lower than filtering

Usage Example:

To filter with lower than on age, we would write:

struct MyQuery: QueryParams {
  let age: LowerThan<Int>
}
let query = MyQuery(age: LowerThan(value: 8))

In a URL it would translate to:

?age=8

Note: The “age=8” format is not an API but an implementation detail that could change in the future.

A codable struct enabling lower than or equal filtering

Usage Example:

To filter with lower than or equal on age, we would write:

struct MyQuery: QueryParams {
  let age: LowerThanOrEqual<Int>
}
let query = MyQuery(age: LowerThanOrEqual(value: 8))

In a URL it would translate to:

?age=8

Note: The “age=8” format is not an API but an implementation detail that could change in the future.

A codable struct enabling to filter with an inclusive range

Usage Example:

To filter on age using an inclusive range, we would write:

struct MyQuery: QueryParams {
  let age: InclusiveRange<Int>
}
let query = MyQuery(age: InclusiveRange(start: 8, end: 14))

In a URL it would translate to:

?age=8,14

Note: The “age=8,14” format is not an API but an implementation detail that could change in the future.

A codable struct enabling to filter with an exlusive range

Usage Example:

To filter on age using an exclusive range, we would write:

struct MyQuery: QueryParams {
  let age: ExclusiveRange<Int>
}
let query = MyQuery(age: ExclusiveRange(start: 8, end: 14))

In a URL it would translate to:

?age=8,14

Note: The “age=8,14” format is not an API but an implementation detail that could change in the future.