swift-sion

SION handler in Swift.

Synopsis

import SION
var sion:SION = [
    "nil":      nil,
    "bool":     true,
    "int":      -42,
    "double":   42.195,
    "string":   "漢字、カタカナ、ひらがなの入ったstring😇",
    "array":    [nil, true, 1, 1.0, "one", [1], ["one":1.0]],
    "dictionary":   [
        "nil":nil, "bool":false, "int":0, "double":0.0, "string":"","array":[], "object":[:]
    ],
    "url":"https://github.com/dankogai/"
]
sion["data"] = .Data("R0lGODlhAQABAIAAAAAAAP///yH5BAEAAAAALAAAAAABAAEAAAIBRAA7")
sion["date"] = .Date(0x0p+0)
sion["ext"]  = .Ext("1NTU") // 0xd4,0xd4,0xd4

This module is both an introduction and a reference implementation of SION, a data serialization formatlike JSON but more capable and expressive . As JSON is originated from a {ECMA,Java}Script literal, SION is originated from a Swift literal. So like JSON was named after JavaScript Object Notation, SION was named after Swift Interchangeable Object Notation. But as its name suggests, SION is language independent like JSON.

SION can serialize anything JSON can plus:

• support Data
• support Date
• non-String keys in Dictionary
• Int and Double distinctively, not Number. Therefore you can exchange 64-bit integers losslessly.
• // comment support!
• Roughly equvalent to MsgPack in terms of capability.
  • MsgPack is a binary serialization while SION is a text serialization.

Type	SION	MsgPack	JSON	Property List	Comment
Nil	✔︎	✔︎	✔︎	❌	plist: .binary only
Bool	✔︎	✔︎	✔︎	✔︎
Int	✔︎	✔︎	❌	✔︎	64bit
Double	✔︎	✔︎	✔︎	✔︎	JSON's Number
String	✔︎	✔︎	✔︎	✔︎	utf-8 encoded
Data	✔︎	✔︎	❌	✔︎	binary blob
Date	✔︎	✔︎	❌	✔︎	.timeIntervalSince1970 in Double
[Self]	✔︎	✔︎	✔︎	✔︎	aka Array
[String:Self]	✔︎	✔︎	✔︎	✔︎	aka Object, Map…
[Self:Self]	✔︎	✔︎	❌	❌	non-String keys
Ext	✔︎	✔︎	❌	❌	msgpack extension

• As you see SION is upper-compatible with JSON and Property List. As a matter of fact, SION can {,de}serialize JSON and Property List.

As for the format details, see the main page of SION.

DESCRIPTION

Is now at DESCRIPTION.md.

Usage

build

$ git clone https://github.com/dankogai/swift-sion.git
$ cd swift-sion # the following assumes your $PWD is here
$ swift build

REPL

Simply

$ swift run --repl

and in your repl,

  1> import SION
  2> let sion:SION = ["swift":["safe","fast","expressive"]]
sion: SION.SION = Object {
  Object = 1 key/value pair {
    [0] = {
      key = "swift"
      value = Array {
        Array = 3 values {
          [0] = String {
            String = "safe"
          }
          [1] = String {
            String = "fast"
          }
          [2] = String {
            String = "expressive"
          }
        }
      }
    }
  }
}

Xcode

Just open ./Package.json

Swift Playgrounds App

Unfortunately Swift Package Manager does not work well with Swift Playgrounds even though it claims to support it (too many error=22 :-). But don't worry. This module is so compact all you need is copy SION.swift.

In case of Swift Playgrounds just add it to one of the sources there. In which case import SION is not necessary.

From Your SwiftPM-Supported Environments

via GUI

Just add:

https://github.com/dankogai/swift-sion.git

via "Add Package Dependencies..." or "Add Package..." menu.

via manually editing Package.swift

Add the following to the dependencies section:

.package(
  url: "https://github.com/dankogai/swift-sion.git", from: "0.0.0"
)

and the following to the .target argument:

.target(
  name: "YourSwiftyPackage",
  dependencies: ["SION"])

Now all you have to do is:

import SION

in your code. Enjoy!

Prerequisite

Swift 5 or better, OS X or Linux to build.