my-mail-ru/swift-binaryencoding

Requirements

Swift 4.0

Design

The library provides managed buffers of raw bytes with copy-on-write behaviour.

BinaryEncodedData

Has various read, write and append methods for all supported types:

	init(minimumCapacity: Int = 0)

	func read<T : NativeBinaryEncoding>(_: T.Type, at offset: inout Int) throws -> T
	func read(_: VarUInt.Type, at offset: inout Int) throws -> UInt
	func read(_: BinaryEncodedData.Type, withSize: Int, at offset: inout Int) throws -> BinaryEncodedData
	func read<S : LengthItem>(_: BinaryEncodedData.Type, withSizeOf: S.Type, at offset: inout Int) throws -> BinaryEncodedData
	func read(_: BinaryEncodedData.Type, withSizeOf: VarUInt.Type, at offset: inout Int) throws -> BinaryEncodedData
	func read(_: String.Type, withSize: Int, at offset: inout Int) throws -> String
	func read<S : LengthItem>(_: String.Type, withSizeOf: S.Type, at offset: inout Int) throws -> String
	func read(_: String.Type, withSizeOf: VarUInt.Type, at offset: inout Int) throws -> String
	func read<T : SequenceItem>(arrayOf: T.Type, withSize: Int, at offset: inout Int) throws -> [T]
	func read<T : SequenceItem, S : LengthItem>(arrayOf: T.Type, withSizeOf: S.Type, at offset: inout Int) throws -> [T]
	func read<T : SequenceItem>(arrayOf: T.Type, withSizeOf: VarUInt.Type, at offset: inout Int) throws -> [T]

	mutating func write<T : NativeBinaryEncoding>(_ value: T, as: T.Type, at offset: inout Int)
	mutating func write(_ value: UInt, as: VarUInt.Type, at offset: inout Int)
	mutating func write(_ value: BinaryEncodedData, at offset: inout Int)
	mutating func write<S : LengthItem>(_ value: BinaryEncodedData, withSizeOf: S.Type, at offset: inout Int)
	mutating func write(_ value: BinaryEncodedData, withSizeOf: VarUInt.Type, at offset: inout Int)
	mutating func write(_ value: String, as: String.Type, at offset: inout Int)
	mutating func write<S : LengthItem>(_ value: String, as: String.Type, withSizeOf: S.Type, at offset: inout Int)
	mutating func write(_ value: String, as: String.Type, withSizeOf: VarUInt.Type, at offset: inout Int)
	mutating func write<C : Collection>(_ value: C, asArrayOf: C.Iterator.Element.Type, at offset: inout Int)
		where C.Iterator.Element : SequenceItem
	mutating func write<C : Collection, S : LengthItem>(_ value: C, asArrayOf: C.Iterator.Element.Type, withSizeOf: S.Type, at offset: inout Int)
		where C.Iterator.Element : SequenceItem
	mutating func write<C : Collection>(_ value: C, asArrayOf: C.Iterator.Element.Type, withSizeOf: VarUInt.Type, at offset: inout Int)
		where C.Iterator.Element : SequenceItem

	mutating func append... // same as write but without parameter (at:)

Usage examples can be found in tests.

UnsafeRawBufferPointer.Reader and UnsafeMutableRawBufferPointer.Writer

These interfaces are unsafe. If you want to use them for effeciency you can find enough infromation in the source code.

Package Metadata

Repository: my-mail-ru/swift-binaryencoding

Default branch: master

README: README.md