mmap_region#

scikitplot.memmap.mmap_region(int size: int, int prot: int = PROT_READ | PROT_WRITE, int flags: int = MAP_PRIVATE | MAP_ANONYMOUS, int fd: int = -1, int offset: int = 0) MemoryMap#

Create a memory-mapped region (convenience function).

Parameters:
sizeint

Size of mapping in bytes

protint, optional

Protection flags. Default: PROT_READ | PROT_WRITE

flagsint, optional

Mapping flags. Default: MAP_PRIVATE | MAP_ANONYMOUS

fdint, optional

File descriptor. Default: -1 (anonymous)

offsetint, optional

File offset. Default: 0

Returns:
MemoryMap

New memory mapping

Parameters:
Return type:

MemoryMap

Examples

>>> m = mmap_region(4096)
>>> m.write(b"Hello")
>>> m.close()