File: buffer.rst

package info (click to toggle)
python-zstandard 0.23.0-5
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 6,936 kB
  • sloc: ansic: 41,411; python: 8,665; makefile: 22; sh: 14
file content (41 lines) | stat: -rw-r--r-- 1,082 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
============
Buffer Types
============

The ``zstandard`` module exposes a handful of custom types for interfacing with
memory buffers. The primary goal of these types is to facilitate efficient
multi-object operations.

The essential idea is to have a single memory allocation provide backing
storage for multiple logical objects. This has 2 main advantages: fewer
allocations and optimal memory access patterns. This avoids having to allocate
a Python object for each logical object and furthermore ensures that access of
data for objects can be sequential (read: fast) in memory.

``BufferSegment``
=================

.. autoclass:: zstandard.BufferSegment
   :members:
   :undoc-members:

``BufferSegments``
==================

.. autoclass:: zstandard.BufferSegments
   :members:
   :undoc-members:

``BufferWithSegments``
======================

.. autoclass:: zstandard.BufferWithSegments
   :members:
   :undoc-members:

``BufferWithSegmentsCollection``
================================

.. autoclass:: zstandard.BufferWithSegmentsCollection
   :members:
   :undoc-members: