RingByteBuffer

open class RingByteBuffer

This class is a simple wrapper around a Data object that allows for treating the data like a stream of bytes. The three basic operations are get(buffer:maxLength:), append(buffer:length:), and prepend(buffer:length:).

NOTE: This class is NOT thread safe.

Show on GitHub

  • The number of bytes in the available.

    Declaration

    Swift

    public final var count: Int { get }
    Show on GitHub

  • Returns true if there are bytes in the ring buffer.

    Declaration

    Swift

    @available(*, deprecated, renamed: "isNotEmpty")
public final var hasBytesAvailable: Bool { get }
    Show on GitHub

  • The total capacity of the buffer.

    Declaration

    Swift

    public final var capacity: Int { get }
    Show on GitHub

  • The room in the buffer for new bytes.

    Declaration

    Swift

    public final var headroom: Int { get }
    Show on GitHub

  • Returns true if the buffer is empty.

    Declaration

    Swift

    public final var isEmpty: Bool { get }
    Show on GitHub

  • Declaration

    Swift

    public final var isNotEmpty: Bool { get }
    Show on GitHub

  • Creates a new instance of ByteBuffer.

    Declaration

    Swift

    public init(initialCapacity: Int = BasicBufferSize)

    Parameters

    initialCapacity

    the initial capacity of the buffer.
    Show on GitHub

  • Clear the buffer.

    Declaration

    Swift

    public final func clear(keepingCapacity: Bool = false)

    Parameters

    keepingCapacity

    true if the capacity should be retained. false if the buffer should shrink to it’s original size.
    Show on GitHub

  • Read a byte from the buffer.

    Declaration

    Swift

    public final func get(byte: inout UInt8) -> Bool

    Parameters

    byte

    a pointer to the variable to receive the byte.

    Return Value

    true if the byte was retrived or false if the buffer was empty.

    Show on GitHub

  • Read a byte from the buffer.

    Declaration

    Swift

    public final func get() -> UInt8?

    Return Value

    The next byte or nil if the buffer is empty.

    Show on GitHub

  • Get, at most, the first maxLength bytes from the buffer.

    Declaration

    Swift

    public final func get(dest: BytePointer, maxLength: Int) -> Int

    Parameters

    dest

    The destination buffer.
    maxLength

    The maximum number of bytes the destination buffer can hold.

    Return Value

    The number of bytes actually gotten.

    Show on GitHub

  • Get bytes from the buffer into the instance of EasyByteBuffer.

    Declaration

    Swift

    @discardableResult
public final func get(dest: EasyByteBuffer) -> Int

    Parameters

    dest

    The destination buffer.

    Return Value

    The number of bytes actually gotten.

    Show on GitHub

  • Get the bytes from the buffer.

    Declaration

    Swift

    public final func get(dest: inout Data, maxLength: Int = -1, overWrite: Bool = true) -> Int

    Parameters

    destData

    The instance of Data that will receive the bytes.
    maxLength

    The maximum number of bytes to get. If -1 then all available bytes will be fetched.
    overWrite

    true if destData should be cleared of any existing bytes first.

    Return Value

    The number of bytes added to destData.

    Show on GitHub

  • Declaration

    Swift

    public final func get(dest: inout [UInt8], maxLength: Int = -1, overWrite: Bool = true) -> Int
    Show on GitHub

  • Get bytes from the END of the buffer.

    Declaration

    Swift

    public final func getFromEnd(dest: UnsafeMutableRawPointer, maxLength: Int) -> Int

    Parameters

    dest

    The destination buffer.
    maxLength

    The maximum number of bytes to read.

    Return Value

    The number of bytes actually read.

    Show on GitHub

  • Append the given RingByteBuffer to this RingByteBuffer.

    Declaration

    Swift

    public final func append(src: RingByteBuffer)

    Parameters

    ringBuffer

    the source ring buffer.
    Show on GitHub

  • Append the given byte to the buffer.

    Declaration

    Swift

    public final func append(byte: UInt8)

    Parameters

    byte

    the byte to append.
    Show on GitHub

  • Append the given bytes to the buffer.

    Declaration

    Swift

    public final func append<T>(src: UnsafePointer<T>, length: Int)

    Parameters

    src

    The source buffer.
    length

    The number of bytes in the source buffer.
    Show on GitHub

  • Append the given bytes to the buffer.

    Declaration

    Swift

    public final func append(src: EasyByteBuffer, reset: Bool = true)

    Parameters

    ezBuffer

    The buffer to append bytes from.
    Show on GitHub

  • Append the given bytes to the buffer.

    Declaration

    Swift

    public final func append(src: UnsafeRawPointer, length: Int)

    Parameters

    src

    The source buffer.
    length

    The number of bytes in the source buffer.
    Show on GitHub

  • Append the given bytes to the buffer.

    Declaration

    Swift

    public final func append<T>(src: UnsafeBufferPointer<T>)

    Parameters

    buffSrc

    the source buffer.
    Show on GitHub

  • Append the given bytes to the buffer.

    Declaration

    Swift

    public final func append(src: UnsafeRawBufferPointer)

    Parameters

    rawBuffSrc

    the source buffer.
    Show on GitHub

  • Append the given bytes to the buffer.

    Declaration

    Swift

    public final func append(src: Data)

    Parameters

    dataSrc

    the source data.
    Show on GitHub

  • Prepend the given byte to the buffer. This byte will be prepended so that it is the next byte that will be read via get(buffer:maxLength:).

    Declaration

    Swift

    public final func prepend(byte: UInt8)

    Parameters

    byte

    The byte to prepend.
    Show on GitHub

  • Prepend the given RingByteBuffer to this RingByteBuffer.

    Declaration

    Swift

    public final func prepend(src: RingByteBuffer)

    Parameters

    ringBuffer

    the source ring buffer.
    Show on GitHub

  • Prepend the given bytes to the buffer. These bytes will be prepended so that they are the next bytes that will be read via get(buffer:maxLength:).

    Declaration

    Swift

    public final func prepend(src: UnsafeRawPointer, length: Int)

    Parameters

    rawSrc

    The source buffer.
    length

    The number of bytes in the source buffer.
    Show on GitHub

  • Prepend the given bytes to the buffer. These bytes will be prepended so that they are the next bytes that will be read via get(buffer:maxLength:).

    Declaration

    Swift

    public final func prepend<T>(src: UnsafePointer<T>, length: Int)

    Parameters

    src

    The source buffer.
    length

    The number of bytes in the source buffer.
    Show on GitHub

  • Prepend the given bytes to the buffer. These bytes will be prepended so that they are the next bytes that will be read via get(buffer:maxLength:).

    Declaration

    Swift

    public final func prepend(src: UnsafeRawBufferPointer)

    Parameters

    rawBuffSrc

    the source buffer.
    Show on GitHub

  • Prepend the given bytes to the buffer. These bytes will be prepended so that they are the next bytes that will be read via get(buffer:maxLength:).

    Declaration

    Swift

    public final func prepend<T>(src: UnsafeBufferPointer<T>)

    Parameters

    buffSrc

    the source buffer.
    Show on GitHub

  • Prepend the given bytes to the buffer. These bytes will be prepended so that they are the next bytes that will be read via get(buffer:maxLength:).

    Declaration

    Swift

    public final func prepend(src: Data)

    Parameters

    srcData

    the source data.
    Show on GitHub

  • Prepend the given bytes to the buffer. These bytes will be prepended so that they are the next bytes that will be read via get(buffer:maxLength:).

    Declaration

    Swift

    public final func prepend(src b: EasyByteBuffer, reset: Bool = true)

    Parameters

    ezBuffer

    the source data.
    Show on GitHub

  • Get’s the data one contiguous range at a time.

    Throws

    Any error thrown by the closure.

    Declaration

    Swift

    public final func forEachContiguousRange(_ body: (ByteROPointer, Int) throws -> Int) throws -> Int

    Parameters

    body

    the closure to call for each block of data.

    Return Value

    The bytes read.

    Show on GitHub

  • Swap every 2 bytes of data.

    Declaration

    Swift

    public final func swapEndian16() -> Int

    Return Value

    The number of bytes swapped.

    Show on GitHub

  • Swap every 4 bytes of data.

    Declaration

    Swift

    public final func swapEndian32() -> Int

    Return Value

    The number of bytes swapped.

    Show on GitHub

  • Swap every 8 bytes of data.

    Declaration

    Swift

    public final func swapEndian64() -> Int

    Return Value

    The number of bytes swapped.

    Show on GitHub