Licensed under either of

Apache License, version 2.0, (LICENSE-APACHE)
MIT license (LICENSE-MIT)

at your option. This file may not be copied, modified, or distributed except according to those terms.

This module implements variable buffer.

Imports

varint

Types

VBuffer = object buffer*: seq[byte] offset*: int: Source Edit

Procs

proc `$`(vb: VBuffer): string {....raises: [Defect], tags: [].}: Return hexadecimal string representation of buffer vb. Source Edit
proc finish(vb: var VBuffer) {....raises: [Defect], tags: [].}: Finishes vb. Source Edit
proc high(vb: VBuffer): int {....raises: [Defect], tags: [].}: Returns number of bytes left in buffer vb. Source Edit
proc initVBuffer(): VBuffer {....raises: [Defect], tags: [].}: Initialize empty VBuffer. Source Edit
proc initVBuffer(data: openArray[byte]; offset = 0): VBuffer {....raises: [Defect], tags: [].}: Initialize VBuffer with copy of data. Source Edit
proc initVBuffer(data: seq[byte]; offset = 0): VBuffer {....raises: [Defect], tags: [].}: Initialize VBuffer with shallow copy of data. Source Edit
proc len(vb: VBuffer): int {....raises: [Defect], tags: [].}: Returns number of bytes left in buffer vb. Source Edit
proc peekArray[T: char | byte](vb: var VBuffer; value: var openArray[T]): int {. ...raises: [Defect].}: Peek array from buffer vb and store result to value.

This procedure will not adjust internal offset.

Returns number of bytes peeked from vb or -1 on error.
Source Edit
proc peekSeq[T: string | seq[byte]](vb: var VBuffer; value: var T): int {. ...raises: [Defect].}: Peek length prefixed array from buffer vb and store result to value.

This procedure will not adjust internal offset.

Returns number of bytes peeked from vb or -1 on error.
Source Edit
proc peekVarint(vb: var VBuffer; value: var LPSomeUVarint): int {. ...raises: [Defect].}: Peek unsigned integer from buffer vb and store result to value.

This procedure will not adjust internal offset.

Returns number of bytes peeked from vb or -1 on error.
Source Edit
proc readArray[T: char | byte](vb: var VBuffer; value: var openArray[T]): int {. inline, ...raises: [Defect].}: Read array from buffer vb and store result to value.

Returns number of bytes consumed from vb or -1 on error.
Source Edit
proc readSeq[T: string | seq[byte]](vb: var VBuffer; value: var T): int {. inline, ...raises: [Defect].}: Read length prefixed array from buffer vb and store result to value.

Returns number of bytes consumed from vb or -1 on error.
Source Edit
proc readVarint(vb: var VBuffer; value: var LPSomeUVarint): int {.inline, ...raises: [Defect].}: Read unsigned integer from buffer vb and store result to value.

Returns number of bytes consumed from vb or -1 on error.
Source Edit
proc writeArray[T: byte | char](vb: var VBuffer; value: openArray[T]) {. ...raises: [Defect].}: Write array value to buffer vb, value will NOT be prefixed with varint length of the array. Source Edit
proc writeLPVarint(vb: var VBuffer; value: LPSomeUVarint) {....raises: [Defect].}: Write value as variable unsigned integer. Source Edit
proc writePBVarint(vb: var VBuffer; value: PBSomeUVarint) {....raises: [Defect].}: Write value as variable unsigned integer. Source Edit
proc writeSeq[T: byte | char](vb: var VBuffer; value: openArray[T]) {. ...raises: [Defect].}: Write array value to buffer vb, value will be prefixed with varint length of the array. Source Edit
proc writeVarint(vb: var VBuffer; value: LPSomeUVarint) {....raises: [Defect].}: Source Edit

Templates

template isEmpty(vb: VBuffer): bool: Returns true if buffer vb is empty. Source Edit
template isEnough(vb: VBuffer; length: int): bool: Returns true if buffer vb holds at least length bytes. Source Edit

libp2p/vbuffer

Imports

Types

Procs

Templates