ByteMemory (F# Compiler Guide) | F# Compiler Guide

F# Compiler Guide

ByteMemory Type

Namespace: FSharp.Compiler.IO
Assembly: FSharp.Compiler.Service.dll
Base Type: obj

A view over bytes. May be backed by managed or unmanaged memory, or memory mapped file.

Instance members

Instance member	Description
`this.AsReadOnly` Full Usage: `this.AsReadOnly` Returns: `ReadOnlyByteMemory`	Returns: `ReadOnlyByteMemory`
`this.AsReadOnlyStream` Full Usage: `this.AsReadOnlyStream` Returns: `Stream` Modifiers: abstract	Get a stream representation of the backing memory. Disposing this will not free up any of the backing memory. Stream cannot be written to. Returns: `Stream`
`this.AsStream` Full Usage: `this.AsStream` Returns: `Stream` Modifiers: abstract	Get a stream representation of the backing memory. Disposing this will not free up any of the backing memory. Returns: `Stream`
`this.Copy` Full Usage: `this.Copy` Parameters: srcOffset : `int` dest : `byte[]` destOffset : `int` count : `int` Modifiers: abstract	srcOffset : `int` dest : `byte[]` destOffset : `int` count : `int`
`this.CopyTo` Full Usage: `this.CopyTo` Parameters: arg0 : `Stream` Modifiers: abstract	arg0 : `Stream`
`this[arg1]` Full Usage: `this[arg1]` Parameters: arg0 : `int` Returns: `byte` Modifiers: abstract	arg0 : `int` Returns: `byte`
`this.Length` Full Usage: `this.Length` Returns: `int` Modifiers: abstract	Returns: `int`
`this.ReadAllBytes` Full Usage: `this.ReadAllBytes` Returns: `byte[]` Modifiers: abstract	Returns: `byte[]`
`this.ReadBytes` Full Usage: `this.ReadBytes` Parameters: pos : `int` count : `int` Returns: `byte[]` Modifiers: abstract	pos : `int` count : `int` Returns: `byte[]`
`this.ReadInt32` Full Usage: `this.ReadInt32` Parameters: pos : `int` Returns: `int` Modifiers: abstract	pos : `int` Returns: `int`
`this.ReadUInt16` Full Usage: `this.ReadUInt16` Parameters: pos : `int` Returns: `uint16` Modifiers: abstract	pos : `int` Returns: `uint16`
`this.ReadUtf8String` Full Usage: `this.ReadUtf8String` Parameters: pos : `int` count : `int` Returns: `string` Modifiers: abstract	pos : `int` count : `int` Returns: `string`
`this.Slice` Full Usage: `this.Slice` Parameters: pos : `int` count : `int` Returns: `ByteMemory` Modifiers: abstract	pos : `int` count : `int` Returns: `ByteMemory`
`this.ToArray` Full Usage: `this.ToArray` Returns: `byte[]` Modifiers: abstract	Returns: `byte[]`

Static members

Static member	Description
`ByteMemory.Empty` Full Usage: `ByteMemory.Empty` Returns: `ByteMemory`	Empty byte memory. Returns: `ByteMemory`
`ByteMemory.FromArray(bytes)` Full Usage: `ByteMemory.FromArray(bytes)` Parameters: bytes : `byte[]` Returns: `ByteMemory`	Creates a ByteMemory object that is backed by a byte array. bytes : `byte[]` Returns: `ByteMemory`
`ByteMemory.FromArray(bytes, offset, length)` Full Usage: `ByteMemory.FromArray(bytes, offset, length)` Parameters: bytes : `byte[]` offset : `int` length : `int` Returns: `ByteMemory`	Creates a ByteMemory object that is backed by a byte array with the specified offset and length. bytes : `byte[]` offset : `int` length : `int` Returns: `ByteMemory`
`ByteMemory.FromMemoryMappedFile(arg1)` Full Usage: `ByteMemory.FromMemoryMappedFile(arg1)` Parameters: arg0 : `MemoryMappedFile` Returns: `ByteMemory`	Create a ByteMemory object that has a backing memory mapped file. arg0 : `MemoryMappedFile` Returns: `ByteMemory`
`ByteMemory.FromUnsafePointer(addr, length, holder)` Full Usage: `ByteMemory.FromUnsafePointer(addr, length, holder)` Parameters: addr : `nativeint` length : `int` holder : `obj` Returns: `ByteMemory`	Creates a ByteMemory object that is backed by a raw pointer. Use with care. addr : `nativeint` length : `int` holder : `obj` Returns: `ByteMemory`