helins.binf.protocol — io.helins/binf 1.1.0

Protocols related to views.

This namespace should be relevant only if a new type needs to implement those. The common user should not have to bother.

Those functions are described in the core helins.binf namespace as well as in the README file.

Depending on the type, not all protocols must be implemented. For instance, a stream-like type might not be seekable and might implement only IRelative* protocols and not IAbsolute* ones.

IAbsoluteReader clj/s protocol

Reading primitive values at an absolute position, without disturbing the current one.

ra-u8 clj/s

(ra-u8 view position)

ra-i32 clj/s

(ra-i32 view position)

ra-f64 clj/s

(ra-f64 view position)

ra-string clj/s

(ra-string view decoder position n-byte)

ra-f32 clj/s

(ra-f32 view position)

ra-u64 clj/s

(ra-u64 view position)

ra-u16 clj/s

(ra-u16 view position)

ra-i8 clj/s

(ra-i8 view position)

ra-i64 clj/s

(ra-i64 view position)

ra-buffer clj/s

(ra-buffer view position n-byte buffer offset)

ra-u32 clj/s

(ra-u32 view position)

ra-i16 clj/s

(ra-i16 view position)

IAbsoluteWriter clj/s protocol

Writing primitive values at an absolute position, without disturbing the current one.

When writing integers, sign is irrelevant and truncation is automatic between all integers that are <= 32-bits.

wa-b16 clj/s

(wa-b16 view position int)

wa-b32 clj/s

(wa-b32 view position int)

wa-b64 clj/s

(wa-b64 view position int)

wa-b8 clj/s

(wa-b8 view position int)

wa-buffer clj/s

(wa-buffer view position buffer offset n-byte)

wa-f32 clj/s

(wa-f32 view position floating)

wa-f64 clj/s

(wa-f64 view position floating)

wa-string clj/s

(wa-string view position string)

IBackingBuffer clj/s protocol

Some views operates over a buffer which can be directly accessed using this protocol.

backing-buffer clj/s

(backing-buffer this)

buffer-offset clj/s

(buffer-offset this)

IEndianess clj/s protocol

Retrieving or modifying the endianess.

endian-get clj/s

(endian-get view)

endian-set clj/s

(endian-set view endianess)

IGrow clj/s protocol

Growing a view means returning a new view with a higher capacity, copying the initial one.

grow clj/s

(grow this n-additional-byte)

IPosition clj/s protocol

Handling the position of a view if it is seekable.

limit clj/s

(limit view)

position clj/s

(position view)

seek clj/s

(seek view position)

skip clj/s

(skip view n-byte)

IRelativeReader clj/s protocol

Reading primitive values from the current position, advancing it as needed. For instance, reading a 32-bit integer will advance the current position by 4 bytes.

rr-i8 clj/s

(rr-i8 view)

rr-i32 clj/s

(rr-i32 view)

rr-i64 clj/s

(rr-i64 view)

rr-buffer clj/s

(rr-buffer view n-byte buffer offset)

rr-u8 clj/s

(rr-u8 view)

rr-u16 clj/s

(rr-u16 view)

rr-f32 clj/s

(rr-f32 view)

rr-f64 clj/s

(rr-f64 view)

rr-string clj/s

(rr-string view decoder n-byte)

rr-u64 clj/s

(rr-u64 view)

rr-i16 clj/s

(rr-i16 view)

rr-u32 clj/s

(rr-u32 view)

IRelativeWriter clj/s protocol

Writing primitive values to the current position, advancing it as needed. For instance, reading a 64-bit float will advance the current position by 8 bytes.

When writing integers, sign is irrelevant and truncation is automatic between all integers that are <= 32-bits.

wr-b16 clj/s

(wr-b16 view int)

wr-b32 clj/s

(wr-b32 view int)

wr-b64 clj/s

(wr-b64 view int)

wr-b8 clj/s

(wr-b8 view int)

wr-buffer clj/s

(wr-buffer view buffer offset n-byte)

wr-f32 clj/s

(wr-f32 view floating)

wr-f64 clj/s

(wr-f64 view floating)

wr-string clj/s

(wr-string view string)

IViewable clj/s protocol

Building a new view.

view clj/s

(view viewable)

(view viewable offset)

(view viewable offset n-byte)