stdlib/mmapView source ↗
mmap
17 items · generated by scribe fromstdlib/mmap.fd· synced 2026-11-15
Contents
- Mmap (struct)
- mmap_file (function)
- mmap_file_create (function)
- mmap_anon (function)
- mmap_ok (function)
- mmap_close (function)
- mmap_flush (function)
- mmap_get (function)
- mmap_set (function)
- mmap_read (function)
- mmap_write (function)
- mmap_slice (function)
- mmap_write_str (function)
- mmap_get_u32 (function)
- mmap_set_u32 (function)
- mmap_get_u64 (function)
- mmap_set_u64 (function)
Mmap
A memory mapping. addr 0 = invalid/failed.
pub struct Mmap {Fields:
| Name | Type |
|---|---|
addr | i64 |
len | i64 |
Defined at line 23
mmap_file
Map path read/write (falls back to read-only if write access is denied). Returns Mmap with addr 0 on failure.
pub fn mmap_file(path: str) -> Mmap {Parameters:
path:str
Returns: Mmap
Defined at line 30
mmap_file_create
Map path read/write, creating it with size bytes when missing or empty (grows the file first so the mapping succeeds).
pub fn mmap_file_create(path: str, size: i64) -> Mmap {Parameters:
path:strsize:i64
Returns: Mmap
Defined at line 39
mmap_anon
Anonymous private mapping of len bytes (zero-initialized).
pub fn mmap_anon(len: i64) -> Mmap {Parameters:
len:i64
Returns: Mmap
Defined at line 58
mmap_ok
True when the mapping is valid.
pub fn mmap_ok(m: Mmap) -> bool {Parameters:
m:Mmap
Returns: bool
Defined at line 66
mmap_close
Unmap. The handle is left invalid (addr = 0).
pub fn mmap_close(m: & mut Mmap) -> void {Parameters:
m:& mut Mmap
Returns: void
Defined at line 71
mmap_flush
Flush modified pages to the file (msync/FlushViewOfFile).
pub fn mmap_flush(m: Mmap) -> i64 {Parameters:
m:Mmap
Returns: i64
Defined at line 80
mmap_get
Read byte at off (0 when out of range).
pub fn mmap_get(m: Mmap, off: i64) -> i64 {Parameters:
m:Mmapoff:i64
Returns: i64
Defined at line 87
mmap_set
Write byte at off (no-op when out of range).
pub fn mmap_set(m: Mmap, off: i64, val: i64) -> void {Parameters:
m:Mmapoff:i64val:i64
Returns: void
Defined at line 95
mmap_read
Read len bytes at off as a Vec.
pub fn mmap_read(m: Mmap, off: i64, len: i64) -> Vec {Parameters:
m:Mmapoff:i64len:i64
Returns: Vec
Defined at line 103
mmap_write
Write a Vec of bytes at off; returns bytes written.
pub fn mmap_write(m: Mmap, off: i64, data: Vec) -> i64 {Parameters:
m:Mmapoff:i64data:Vec
Returns: i64
Defined at line 114
mmap_slice
Read bytes at off as a string.
pub fn mmap_slice(m: Mmap, off: i64, len: i64) -> str {Parameters:
m:Mmapoff:i64len:i64
Returns: str
Defined at line 124
mmap_write_str
Write a string’s bytes at off; returns bytes written.
pub fn mmap_write_str(m: Mmap, off: i64, s: str) -> i64 {Parameters:
m:Mmapoff:i64s:str
Returns: i64
Defined at line 129
mmap_get_u32
pub fn mmap_get_u32(m: Mmap, off: i64) -> i64 {Parameters:
m:Mmapoff:i64
Returns: i64
Defined at line 140
mmap_set_u32
pub fn mmap_set_u32(m: Mmap, off: i64, v: i64) -> void {Parameters:
m:Mmapoff:i64v:i64
Returns: void
Defined at line 144
mmap_get_u64
pub fn mmap_get_u64(m: Mmap, off: i64) -> i64 {Parameters:
m:Mmapoff:i64
Returns: i64
Defined at line 151
mmap_set_u64
pub fn mmap_set_u64(m: Mmap, off: i64, v: i64) -> void {Parameters:
m:Mmapoff:i64v:i64
Returns: void
Defined at line 161
Generated by scribe, the Fides documentation generator