Class MappedAccessor<T>

Abstract representation of a memory-mapped accessor: Provides random access to unmanaged blocks of memory from managed code.
Inheritance
IDisposable
MappedAccessor<T>
MappedAccessorByte
MappedAccessorDouble
MappedAccessorInt16
MappedAccessorInt32
MappedAccessorInt64
MappedAccessorSingle
MappedAccessorUInt16
MappedAccessorUInt32
MappedAccessorUInt64
MappedAccessorVariable<T>
Namespace: Mars.Common.IO.Mapped
Assembly: Mars.IO.dll
Syntax
public abstract class MappedAccessor<T> : IDisposable
Type Parameters
Name Description
T

Constructors

MappedAccessor(MemoryMap, Stream, Int32)

Creates a new mapped accessor.
Declaration
protected MappedAccessor(MemoryMap file, Stream stream, int singleElementSize)
Parameters
Type Name Description
MemoryMap file
Stream stream
System.Int32 singleElementSize

Fields

SingleElementSize

The size of a single element if constant.
Declaration
protected readonly int SingleElementSize
Field Value
Type Description
System.Int32

Stream

Holds the stream.
Declaration
protected readonly Stream Stream
Field Value
Type Description
Stream

Properties

CanWrite

Determines whether the accessory is writable.
Declaration
public virtual bool CanWrite { get; }
Property Value
Type Description
System.Boolean

Capacity

Gets the capacity of this memory mapped file in bytes.
Declaration
public long Capacity { get; }
Property Value
Type Description
System.Int64

CapacityElements

Gets the capacity of this memory mapped file in the number of structs it can store.
Declaration
public long CapacityElements { get; }
Property Value
Type Description
System.Int64

ElementSize

Gets the size in bytes of one element.
Declaration
public int ElementSize { get; }
Property Value
Type Description
System.Int32

ElementSizeFixed

Returns true if this accessor is for elements of a fixed size.
Declaration
public virtual bool ElementSizeFixed { get; }
Property Value
Type Description
System.Boolean

Methods

CopyTo(Stream)

Copies the data in this accessor to the given stream.
Declaration
public void CopyTo(Stream stream)
Parameters
Type Name Description
Stream stream

CopyTo(Stream, Int64, Int32)

Copies the data in this accessor to the given stream starting at the given position until position + length.
Declaration
public void CopyTo(Stream stream, long position, int length)
Parameters
Type Name Description
Stream stream
System.Int64 position
System.Int32 length

CopyTo(Stream, Int64, Int32, Byte[])

Copies the data in this accessor to the given stream starting at the given position until position + length.
Declaration
public void CopyTo(Stream stream, long position, int length, byte[] buffer)
Parameters
Type Name Description
Stream stream
System.Int64 position
System.Int32 length
System.Byte[] buffer

Dispose()

Disposes of all native resources associated with this object.
Declaration
public virtual void Dispose()

ReadArray(Int64, T[], Int32, Int32)

Reads elements starting at the given position.
Declaration
public virtual int ReadArray(long position, T[] array, int offset, int count)
Parameters
Type Name Description
System.Int64 position
T[] array
System.Int32 offset
System.Int32 count
Returns
Type Description
System.Int32

ReadFrom(Stream, Int64, ref T)

Reads appropriate amount of bytes from the given stream at the given position and returns the structure.
Declaration
public abstract long ReadFrom(Stream stream, long position, ref T structure)
Parameters
Type Name Description
Stream stream
System.Int64 position
T structure
Returns
Type Description
System.Int64

ReadFrom(Int64, ref T)

Reads appropriate amount of bytes from the default stream at the given position and returns the structure.
Declaration
public virtual long ReadFrom(long position, ref T structure)
Parameters
Type Name Description
System.Int64 position
T structure
Returns
Type Description
System.Int64

WriteArray(Int64, T[], Int32, Int32)

Writes an array of elements at the given position.
Declaration
public virtual long WriteArray(long position, T[] array, int offset, int count)
Parameters
Type Name Description
System.Int64 position
T[] array
System.Int32 offset
System.Int32 count
Returns
Type Description
System.Int64

WriteTo(Stream, Int64, ref T)

Converts the structure to bytes and writes them to the given stream.
Declaration
public abstract long WriteTo(Stream stream, long position, ref T structure)
Parameters
Type Name Description
Stream stream
System.Int64 position
T structure
Returns
Type Description
System.Int64

WriteTo(Int64, ref T)

Converts the structure to bytes and writes them to the stream default.
Declaration
public virtual long WriteTo(long position, ref T structure)
Parameters
Type Name Description
System.Int64 position
T structure
Returns
Type Description
System.Int64

Extension Methods