YamlSwift
Load YAML and JSON documents using Swift.
YamlSwift parses a string of YAML document(s) (or a JSON document) and returns a Yaml enum value representing that string.
Install
Use Carthage to build and install.
Or use CocoaPods : Add pod 'Yaml' to your Podfile and run pod install.
It supports Swift Package Manager.
.package(
url: "https://github.com/behrang/YamlSwift.git",
from: "
And:
.target(
name: "YourProject",
dependencies: ["Yaml"]),
API
import
To use it, you should import it using the following statement:
import Yaml
Yaml
A Yaml value can be any of these cases:
enum Yaml {
case null
case bool(Bool)
case int(Int)
case double(Double)
case string(String)
case array([Yaml])
case dictionary([Yaml: Yaml])
}
Yaml.load
Yaml.load (String) throws -> Yaml
Takes a string of a YAML document and returns a Yaml enum.
let value = try! Yaml.load("a: 1\nb: 2")
print(value["a"]) // Int(1)
print(value["b"]) // Int(2)
print(value["c"]) // Null
If the input document is invalid or contains more than one YAML document, an error is thrown.
do {
let value = try Yaml.load("a\nb: 2")
}
catch {
print(error) // expected end, near "b: 2"
}
Yaml.loadMultiple
Yaml.loadMultiple (String) throws -> [Yaml]
Takes a string of one or more YAML documents and returns [Yaml].
let value = try! Yaml.loadMultiple("---\na: 1\nb: 2\n---\na: 3\nb: 4")
print(value[0]["a"]) // Int(1)
print(value[1]["a"]) // Int(3)
It will throw an error if an error is encountered in any of the documents.
Yaml#[Int] -> Yaml
value[Int] -> Yaml
value[Int] = Yaml
If used on a Yaml.array value, it will return the value at the specified index. If the index is invalid or the value is not a Yaml.array, Yaml.null is returned. You can also set a value at a specific index. Enough elements will be added to the wrapped array to set the specified index. If the value is not a Yaml.array, it will change to it after set.
var value = try! Yaml.load("- Behrang\n- Maryam")
print(value[0]) // String(Behrang)
print(value[1]) // String(Maryam)
print(value[2]) // Null
value[2] = "Radin"
print(value[2]) // String(Radin)
Yaml#[Yaml] -> Yaml
value[Yaml] -> Yaml
value[Yaml] = Yaml
If used on a Yaml.dictionary value, it will return the value for the specified key. If a value for the specified key does not exist, or value is not a Yaml.dictionary, Yaml.null is returned. You can also set a value for a specific key. If the value is not a Yaml.dictionary, it will change to it after set.
Since Yaml is a literal convertible type, you can pass simple values to this method.
var value = try! Yaml.load("first name: Behrang\nlast name: Noruzi Niya")
print(value["first name"]) // String(Behrang)
print(value["last name"]) // String(Noruzi Niya)
print(value["age"]) // Null
value["first name"] = "Radin"
value["age"] = 1
print(value["first name"]) // String(Radin)
print(value["last name"]) // String(Noruzi Niya)
print(value["age"]) // Int(1)
Yaml#bool
value.bool -> Bool?
Returns an Optional value. If the value is a Yaml.bool value, the wrapped value is returned. Otherwise nil is returned.
let value = try! Yaml.load("animate: true\nshow tip: false\nusage: 25")
print(value["animate"].bool) // Optional(true)
print(value["show tip"].bool) // Optional(false)
print(value["usage"].bool) // nil
Yaml#int
value.int -> Int?
Returns an Optional value. If the value is a Yaml.int value, the wrapped value is returned. Otherwise nil is returned.
let value = try! Yaml.load("a: 1\nb: 2.0\nc: 2.5")
print(value["a"].int) // Optional(1)
print(value["b"].int) // Optional(2)
print(value["c"].int) // nil
Yaml#double
value.double -> Double?
Returns an Optional value. If the value is a Yaml.double value, the wrapped value is returned. Otherwise nil is returned.
let value = try! Yaml.load("a: 1\nb: 2.0\nc: 2.5\nd: true")
print(value["a"].double) // Optional(1.0)
print(value["b"].double) // Optional(2.0)
print(value["c"].double) // Optional(2.5)
print(value["d"].double) // nil
Yaml#string
value.string -> String?
Returns an Optional value. If the value is a Yaml.string value, the wrapped value is returned. Otherwise nil is returned.
let value = try! Yaml.load("first name: Behrang\nlast name: Noruzi Niya\nage: 33")
print(value["first name"].string) // Optional("Behrang")
print(value["last name"].string) // Optional("Noruzi Niya")
print(value["age"].string) // nil
Yaml#array
value.array -> [Yaml]?
Returns an Optional value. If the value is a Yaml.array value, the wrapped value is returned. Otherwise nil is returned.
let value = try! Yaml.load("languages:\n - Swift: true\n - Objective C: false")
print(value.array) // nil
print(value["languages"].array) // Optional([Dictionary([String(Swift): Bool(true)]), Dictionary([String(Objective C): Bool(false)])])
Yaml#dictionary
value.dictionary -> [Yaml: Yaml]?
Returns an Optional value. If the value is a Yaml.dictionary value, the wrapped value is returned. Otherwise nil is returned.
let value = try! Yaml.load("- Swift: true\n- Objective C: false")
print(value.dictionary) // nil
print(value[0].dictionary) // Optional([String(Swift): Bool(true)])
Yaml#count
value.count -> Int?
Returns an Optional value. If the value is either a Yaml.array or a Yaml.dictionary value, the count of elements is returned. Otherwise nil is returned.
let value = try! Yaml.load("- Swift: true\n- Objective C: false")
print(value.count) // Optional(2)
print(value[0].count) // Optional(1)
print(value[0]["Swift"].count) // nil
License
MIT
31 Nov 22, 2021
8 Nov 22, 2022
43 Dec 15, 2022
0 Oct 29, 2021
454 Oct 30, 2022
2.6k Dec 29, 2022
9 Aug 22, 2022
249 Jun 29, 2022
0 Dec 9, 2021
1 Jan 9, 2022
964 Dec 14, 2022
8.5k Jan 3, 2023
611 Oct 23, 2022
4.1k Dec 29, 2022
509 Sep 4, 2022
132 Dec 5, 2021
605 Jun 29, 2022