Module golden_apple::generalized

generalized contains many repetetive and unnecisary functions for reading and writing data. For sake of completion and inclusiveness, all standard types that may be written over the stream, no matter how easy to parse, are included here.

Functions

boolean_from_bytes

Woefully unnessicary. Seriously, bools are just 0x00 or 0x01. Side note: this function will always read just a single byte, making half of the return type pointless.

boolean_from_reader

Woefully unnessicary. Seriously, bools are just 0x00 or 0x01.

boolean_to_bytes

What’s wrong with you? This isn’t something you should need or use. It’s one byte. It’s not even possible to get an error here.

boolean_to_writer

Either writes 0x00 or 0x01 to the writer. Come on, you don’t need this.

byte_from_bytes

Reads a Java Byte from a list of bytes. Returns the value and number of bytes read.

byte_from_reader

Uses a Read type to read a Java Byte from the stream.

byte_to_bytes

Returns a Java Byte as an array of bytes.

byte_to_writer

Writes a Java Byte to a Write type.

double_from_bytes

Reads a Java Double from a list of bytes. Returns the value and number of bytes read.

double_from_reader

Uses a Read type to read a Java Double from the stream.

double_to_bytes

Returns a Java Double as an array of bytes.

double_to_writer

Writes a Java Double to a Write type.

float_from_bytes

Reads a Java Float from a list of bytes. Returns the value and number of bytes read.

float_from_reader

Uses a Read type to read a Java Float from the stream.

float_to_bytes

Returns a Java Float as an array of bytes.

float_to_writer

Writes a Java Float to a Write type.

int_from_bytes

Reads a Java Int from a list of bytes. Returns the value and number of bytes read.

int_from_reader

Uses a Read type to read a Java Int from the stream.

int_to_bytes

Returns a Java Int as an array of bytes.

int_to_writer

Writes a Java Int to a Write type.

long_from_bytes

Reads a Java Long from a list of bytes. Returns the value and number of bytes read.

long_from_reader

Uses a Read type to read a Java Long from the stream.

long_to_bytes

Returns a Java Long as an array of bytes.

long_to_writer

Writes a Java Long to a Write type.

short_from_bytes

Reads a Java Short from a list of bytes. Returns the value and number of bytes read.

short_from_reader

Uses a Read type to read a Java Short from the stream.

short_to_bytes

Returns a Java Short as an array of bytes.

short_to_writer

Writes a Java Short to a Write type.

string_from_bytes

Reads a String from a series of bytes. This function returns the string without the VarInt length prefix, but does include the size of that VarInt in the final size calculation. The text is not verified to be utf8.

string_from_reader

Reads a String from a type implimenting Read. This function returns the string without the VarInt length prefix, and does not verify that the text is utf8.

string_to_bytes

Converts a String to a VarInt length prefixed series of bytes.

string_to_writer

Writes a String to a Write interface.

unsigned_byte_from_bytes

Reads an unsigned Java Byte from a list of bytes. Returns the value and number of bytes read.

unsigned_byte_from_reader

Uses a Read type to read an unsigned Java Byte from the stream.

unsigned_byte_to_bytes

Returns an unsigned Java Byte as an array of bytes.

unsigned_byte_to_writer

Writes an unsigned Java Byte to a Write type.

unsigned_short_from_bytes

Reads an unsigned Java Short from a list of bytes. Returns the value and number of bytes read.

unsigned_short_from_reader

Uses a Read type to read an unsigned Java Short from the stream.

unsigned_short_to_bytes

Returns an unsigned Java Short as an array of bytes.

unsigned_short_to_writer

Writes an unsigned Java Short to a Write type.