11# MemoryMappedFile
22
3- MemoryMappedFile is a PowerShell module for creating, reading, writing, and closing named memory-mapped files.
4-
5- ## Prerequisites
6-
7- - PowerShell with ` Microsoft.PowerShell.PSResourceGet ` available for ` Install-PSResource ` .
8- - The [ PSModule framework] ( https://github.com/PSModule ) is used for building, testing, and publishing the module.
3+ MemoryMappedFile is a PowerShell module for managing memory-mapped files.
94
105## Installation
116
@@ -16,45 +11,17 @@ Install-PSResource -Name MemoryMappedFile
1611Import-Module -Name MemoryMappedFile
1712```
1813
19- ## Commands
20-
21- - ` New-MemoryMappedFile ` creates a named memory-mapped file from a backing file path.
22- - ` Set-MemoryMappedFile ` returns an existing map by name or creates it when missing.
23- - ` Get-MemoryMappedFile ` opens an existing named map.
24- - ` Set-MemoryMappedFileContent ` writes UTF-8 string content to a named map.
25- - ` Read-MemoryMappedFileContent ` reads UTF-8 string content from a named map.
26- - ` Show-MemoryMappedFile ` displays map content repeatedly in the console.
27- - ` Close-MemoryMappedFile ` disposes a named map.
28-
29- ## Usage
30-
31- Create or open a map backed by a file:
32-
33- ``` powershell
34- Set-MemoryMappedFile -Name 'SharedMap' -Path './shared.dat' -Size 2MB
35- ```
36-
37- Write and read string content:
14+ ## Documentation
3815
39- ``` powershell
40- Set-MemoryMappedFileContent -Name 'SharedMap' -Path './shared.dat' -Content 'Hello from PowerShell'
41- Read-MemoryMappedFileContent -Name 'SharedMap'
42- ```
16+ Documentation is published at [ psmodule.io/MemoryMappedFile] ( https://psmodule.io/MemoryMappedFile/ ) .
4317
44- Close the map when finished :
18+ Use PowerShell help and command discovery for module details :
4519
4620``` powershell
47- Close-MemoryMappedFile -Name 'SharedMap'
21+ Get-Command -Module MemoryMappedFile
22+ Get-Help <CommandName> -Examples
4823```
4924
50- ## Examples
51-
52- More usage examples are available in the [ examples] ( examples ) folder.
53-
54- ## Documentation
55-
56- Command documentation is published at [ psmodule.io/MemoryMappedFile] ( https://psmodule.io/MemoryMappedFile/ ) .
57-
5825## Contributing
5926
6027Issues and pull requests are welcome. Please use the repository issue tracker to report bugs, request features, or discuss improvements.
0 commit comments