[plum.utilities] Module API Reference

plum.utilities.getbytes(buffer: bytes, offset: int, dump: plum.dump.Record, nbytes: Optional[int] = None) → Tuple[bytes, int]

Get bytes from buffer (get remainder in buffer if nbytes is None).

plum.utilities.pack(value: Any, fmt: Union[Dict[str, Any], List[Any], plum.transform.Transform, Tuple[Any, ...], Type[plum.data.Data], None] = None) → bytes

Pack value as formatted bytes.

Raises:PackError if type error, value error, etc.

plum.utilities.pack_and_dump(value: Any, fmt: Union[Dict[str, Any], List[Any], plum.transform.Transform, Tuple[Any, ...], Type[plum.data.Data], None] = None) → Tuple[bytes, plum.dump.Dump]

Pack value as formatted bytes and produce bytes summary.

Raises:PackError if type error, value error, etc.

plum.utilities.unpack(fmt: Union[Dict[str, Any], List[Any], plum.transform.Transform, Tuple[Any, ...], Type[plum.data.Data], None], buffer: bytes) → Any

Unpack value from formatted bytes.

Raises:UnpackError if insufficient bytes or value error

plum.utilities.unpack_and_dump(fmt: Union[Dict[str, Any], List[Any], plum.transform.Transform, Tuple[Any, ...], Type[plum.data.Data], None], buffer: bytes)

Unpack value from formatted bytes and produce a packed bytes summary.

Raises:UnpackError if insufficient bytes or value error