Display the source code in std/mmfile.d from which this page was generated on github.

If you spot a problem with this page, click here to create a Bugzilla issue.

Quickly fork, edit online, and submit a pull request for this page. Requires a signed-in GitHub account. This works well for small changes. If you'd like to make larger changes you may want to consider using local clone.

Class `std.mmfile.MmFile`

MmFile objects control the memory mapped file resource.


						
				class MmFile
				;

Constructors

Name	Description
`this` (filename)	Open memory mapped file filename for reading. File is closed when the object instance is deleted.
`this` (filename, mode, size, address, window)	Open memory mapped file filename in mode. File is closed when the object instance is deleted.

Properties

Name	Type	Description
`length`[get]	`ulong`	Gives size in bytes of the memory mapped file.

Methods

Name	Description
`mode` ()	Read-only property returning the file mode.
`opIndex` (i)	Returns byte at index i in file.
`opIndexAssign` (value, i)	Sets and returns byte at index i in file to value.
`opSlice` ()	Returns entire file contents as an array.
`opSlice` (i1, i2)	Returns slice of file contents as an array.
`factory` (classname)	Create instance of class specified by the fully qualified name classname. The class must either have no constructors or have a default constructor.
`opCmp` (o)	Compare with another Object obj.
`opEquals` (o)	Test whether `this` is equal to `o`. The default implementation only compares by identity (using the `is` operator). Generally, overrides for `opEquals` should attempt to compare objects by their contents.
`toHash` ()	Compute hash function for Object.
`toString` ()	Convert Object to a human readable string.

Enums

Name	Description
`Mode`	The mode the memory mapped file is opened with.

Aliases

Name	Description
`opDollar`	Forwards `length`.

Authors

Walter Bright, Matthew Wilson

License

Boost License 1.0.