streamview 2.0.0

Zero-copy non-blocking pipe-like structure

streamview

Zero-copy non-blocking pipe-like structure

Install

Production

pip install streamview

Development

git clone https://github.com/hpca-uji/streamview.git
cd streamview
pip install -e .

Documentation

Classes

• Stream()

  Zero-copy non-blocking pipe-like

  Interface mimics a non-blocking BufferedIOBase, but operations return memoryviews instead of bytes.

  Operations consume the stream. Operations are not thread-safe. Reader is responsible of releasing buffers. Writer hands off responsibility over buffers.

  Stream has with, bytes, bool, copy and deepcopy support.

  Extends: BufferedIOBase

  • __len__() -> int

    Number of buffers held in stream

  • nbytes -> int

    Number of bytes held in stream

  • buffers -> Iterable[memoryview]

    Peeking iterator over buffers

  • __getitem__(index) -> memoryview

    Peek a buffer from the stream

  • unreadbuffer(b: memoryview) -> int

    Unread a buffer into the stream

  • readbuffer() -> memoryview

    Read a buffer from stream

  • readbuffers() -> Iterable[memoryview]

    Read all buffers from stream

  • unwritebuffer() -> memoryview

    Unwrite a buffer from the stream

  • writebuffer(b: memoryview) -> int

    Write a buffer into the stream

  • writebuffers(bs: Iterable[memoryview]) -> int

    Write many buffers into the stream

  • frombuffer(b: Buffer) -> Stream

    Construct a stream from a buffer

  • tobuffer() -> memoryview

    Transform stream to contiguous buffer (may copy)

  • copy() -> Stream

    Shallow copy of stream

Functions

• byteview(b: Buffer) -> memoryview

  Return a byte view of a buffer

Acknowledgments

The library has been partially supported by:

• Project PID2023-146569NB-C22 "Inteligencia sostenible en el Borde-UJI" funded by the Spanish Ministry of Science, Innovation and Universities.
• Project C121/23 Convenio "CIBERseguridad post-Cuántica para el Aprendizaje FEderado en procesadores de bajo consumo y aceleradores (CIBER-CAFE)" funded by the Spanish National Cybersecurity Institute (INCIBE).