DecodeData

public struct DecodeData

Decoder

Provides easy methods for Decoding values out of a Data Stream

index
Current Index

The index into the data the decoder is at
Declaration
Swift

private(set) public var index: Int
init(startIndex:)
Undocumented
Declaration
Swift

public init(startIndex: Int = 0)


                      
                      
                      decodeData(_:length:)

Decodes Raw data from data Stream

Declaration

Swift

mutating func decodeData(_ data: Data, length: Int) -> Data

Parameters

`data`	Data stream
`length`	Length of Data to pull out of stream

Return Value

Data Instance


                      
                      
                      decodeDataIfPresent(_:length:)

Decodes Raw data from data Stream only if Present

Declaration

Swift

mutating func decodeDataIfPresent(_ data: Data, length: Int) -> Data?

Parameters

`data`	Data stream
`length`	Length of Data to pull out of stream

Return Value

Data Instance


                      
                      
                      decodeNibble(_:)

Decodes Nibble from the data stream

Declaration

Swift

mutating func decodeNibble(_ data: Data) -> Nibble

Parameters


                                  data

Data stream

Return Value

Nibble Instance


                      
                      
                      decodeNibbleIfPresent(_:)

Decodes Nibble from the data stream only if present

Declaration

Swift

mutating func decodeNibbleIfPresent(_ data: Data) -> Nibble?

Parameters


                                  data

Data stream

Return Value

Nibble value


                      
                      
                      decodeInt8(_:)

Decodes Int8 from the data stream

Declaration

Swift

mutating func decodeInt8(_ data: Data) -> Int8

Parameters


                                  data

Data stream

Return Value

Int8 value


                      
                      
                      decodeInt8IfPresent(_:)

Decodes Int8 from the data stream only if present

Declaration

Swift

mutating func decodeInt8IfPresent(_ data: Data) -> Int8?

Parameters


                                  data

Data stream

Return Value

UInt8 value


                      
                      
                      decodeUInt8(_:)

Decodes UInt8 from the data stream

Declaration

Swift

mutating func decodeUInt8(_ data: Data) -> UInt8

Parameters


                                  data

Data stream

Return Value

UInt8 value


                      
                      
                      decodeUInt8IfPresent(_:)

Decodes UInt8 from the data stream only if present

Declaration

Swift

mutating func decodeUInt8IfPresent(_ data: Data) -> UInt8?

Parameters


                                  data

Data stream

Return Value

UInt8 value


                      
                      
                      decodeInt16(_:)

Decodes Int16 from the data stream

Declaration

Swift

mutating func decodeInt16(_ data: Data) -> Int16

Parameters


                                  data

Data stream

Return Value

Int16 value


                      
                      
                      decodeInt16IfPresent(_:)

Decodes Int16 from the data stream only if present

Declaration

Swift

mutating func decodeInt16IfPresent(_ data: Data) -> Int16?

Parameters


                                  data

Data stream

Return Value

Int16 value


                      
                      
                      decodeUInt16(_:)

Deocdes UInt16 from the data stream

Declaration

Swift

mutating func decodeUInt16(_ data: Data) -> UInt16

Parameters


                                  data

Data stream

Return Value

UInt16 value


                      
                      
                      decodeUInt16IfPresent(_:)

Decodes UInt16 from the data stream only if present

Declaration

Swift

mutating func decodeUInt16IfPresent(_ data: Data) -> UInt16?

Parameters


                                  data

Data stream

Return Value

UInt16 value


                      
                      
                      decodeUInt24(_:)

Decodes UInt24 from the data stream

Declaration

Swift

mutating func decodeUInt24(_ data: Data) -> Int

Parameters


                                  data

Data stream

Return Value

Int value


                      
                      
                      decodeInt24(_:)

Decodes Int24 from the data stream

Declaration

Swift

mutating func decodeInt24(_ data: Data) -> Int

Parameters


                                  data

Data stream

Return Value

Int value


                      
                      
                      decodeInt32(_:)

Decodes Int32 from the data stream

Declaration

Swift

mutating func decodeInt32(_ data: Data) -> Int32

Parameters


                                  data

Data stream

Return Value

Int32 value


                      
                      
                      decodeInt32IfPresent(_:)

Decodes Int32 from the data stream only if present

Declaration

Swift

mutating func decodeInt32IfPresent(_ data: Data) -> Int32?

Parameters


                                  data

Data stream

Return Value

Int32 value


                      
                      
                      decodeUInt32(_:)

Decodes UInt32 from the data stream

Declaration

Swift

mutating func decodeUInt32(_ data: Data) -> UInt32

Parameters


                                  data

Data stream

Return Value

UInt32 value


                      
                      
                      decodeUInt32IfPresent(_:)

Decodes UInt32 from the data stream only if present

Declaration

Swift

mutating func decodeUInt32IfPresent(_ data: Data) -> UInt32?

Parameters


                                  data

Data stream

Return Value

UInt32 value


                      
                      
                      decodeUInt48(_:)

Decodes UInt48 from the data stream

Declaration

Swift

mutating func decodeUInt48(_ data: Data) -> UInt

Parameters


                                  data

Data stream

Return Value

UInt value


                      
                      
                      decodeInt64(_:)

Deocdes Int64 from the data stream

Declaration

Swift

mutating func decodeInt64(_ data: Data) -> Int64

Parameters


                                  data

Data stream

Return Value

Int64 value


                      
                      
                      decodeInt64IfPresent(_:)

Decodes Int64 from the data stream only if present

Declaration

Swift

mutating func decodeInt64IfPresent(_ data: Data) -> Int64?

Parameters


                                  data

Data stream

Return Value

Int64 value


                      
                      
                      decodeUInt64(_:)

Decodes UInt64 from the data stream

Declaration

Swift

mutating func decodeUInt64(_ data: Data) -> UInt64

Parameters


                                  data

Data stream

Return Value

UInt64 value


                      
                      
                      decodeUInt64IfPresent(_:)

Decodes UInt64 from the data stream only if present

Declaration

Swift

mutating func decodeUInt64IfPresent(_ data: Data) -> UInt64?

Parameters


                                  data

Data stream

Return Value

UInt64 value

Other Decodes


                      
                      
                      decodeIPAddress(_:fromLittleEndian:)

Decodes IP Address from the data stream

Declaration

Swift

mutating func decodeIPAddress(_ data: Data, fromLittleEndian: Bool = false) -> String

Parameters

`data`	Data stream
`fromLittleEndian`	If IP Address is encoded as Little Endian

Return Value

String Representation of the IP Address


                      
                      
                      decodeMACAddress(_:fromLittleEndian:)

Decodes MAC Address from the data stream

Declaration

Swift

mutating func decodeMACAddress(_ data: Data, fromLittleEndian: Bool = false) -> MACAddress

Parameters

`data`	Data stream
`fromLittleEndian`	If MAC is encoded as Little Endian

Return Value

String Representation of the MAC Address

ANT Decodes


                      
                      
                      decodeANTToggleByte(_:)

Decodes ANT Toggle Byte from the data stream

Declaration

Swift

mutating func decodeANTToggleByte(_ data: Data) -> ANTToggleByte

Parameters


                                  data

Data stream

Return Value

ANTToggleByte Instance

IEEE-754 Decodes


                      
                      
                      decodeFloat32(_:)

Decodes IEEE-754 Float32 from the data stream

Declaration

Swift

mutating func decodeFloat32(_ data: Data) -> Float32

Parameters


                                  data

Data stream

Return Value

Float32 Value


                      
                      
                      decodeFloat32IfPresent(_:)

Decodes IEEE-754 Float32 from the data stream if present

Declaration

Swift

mutating func decodeFloat32IfPresent(_ data: Data) -> Float32?

Parameters


                                  data

Data stream

Return Value

Float32 Value


                      
                      
                      decodeFloat64(_:)

Decodes IEEE-754 Float64 from the data stream

Declaration

Swift

mutating func decodeFloat64(_ data: Data) -> Float64

Parameters


                                  data

Data stream

Return Value

Float64 Value


                      
                      
                      decodeFloat64IfPresent(_:)

Decodes IEEE-754 Float64 from the data stream if present

Declaration

Swift

mutating func decodeFloat64IfPresent(_ data: Data) -> Float64?

Parameters


                                  data

Data stream

Return Value

Float64 Value

IEEE-11073 Decodes


                      
                      
                      decodeSFloatValue(_:)

Decodes IEEE-11073 16-bit SFLOAT from the data stream

Declaration

Swift

mutating func decodeSFloatValue(_ data: Data) -> Float

Parameters


                                  data

Data stream

Return Value

Float value


                      
                      
                      decodeSFloatValueIfPresent(_:)

Decodes IEEE-11073 16-bit SFLOAT from the data stream only if Present

Declaration

Swift

mutating func decodeSFloatValueIfPresent(_ data: Data) -> Float?

Parameters


                                  data

Data stream

Return Value

Float value


                      
                      
                      decodeFloatValue(_:)

Decodes IEEE-11073 32-bit FLOAT from the data stream

Declaration

Swift

mutating func decodeFloatValue(_ data: Data) -> Float

Parameters


                                  data

Data stream

Return Value

Float value


                      
                      
                      decodeFloatValueifPresent(_:)

Decodes IEEE-11073 32-bit FLOAT from the data stream

Declaration

Swift

mutating func decodeFloatValueifPresent(_ data: Data) -> Float?

Parameters


                                  data

Data stream

Return Value

Float value