Value

public protocol Value: Expr, CustomStringConvertible

Value is the top level of the value tree hierarchy. It represents a valid FaunaDB entry returned by the server.

Reference

Traversal API

You can use the traversal API to traverse and convert a database entry to an native type.

The traversal API uses type inference to convert the returned value to the desired type.

The traversal API methods are shortcuts for field extractors. See FaunaDB.Field for more information.

Examples of field extractions and type conversions:

// Attempts to convert the root value to a String
let name: String? = try! value.get()

// Transverses to the path "array" -> 1 -> "value" and
// attempts to convert its result to an Int
let count: Int? = try! value.get("array", 1, "count")

// Using a predefined field
let nameField = Field<String>("data", "name")
let name = try! value.get(field: nameField)

// Extracting an array
let tags1 = try! value
    .at("data")
    .get(asArrayOf: Field<String>())

let tags2: [String] = try! value.get("data")

// Extracting a dictionary
let nickNamesByName1 = try! value
    .at("data")
    .get(asDictionaryOf: Field<String>())

let nickNamesByName2: [String: String] =
    try! value.get("data")

// Extracting a struct that implements
// FaunaDB.Decodable
let blogPost: Post = try! value.get("data")!