struct BlockIdSlot in Tinman.Core.Database

Describes the location of a 64-bit word for storing a block ID value in the file of a block storage.

struct

BlockIdSlot

See also:

BlockStorage
BlockIndex

Public / Constants

IndexFormat

Block index format for BlockIdSlot values.

public static readonly field	IndexFormat
type	IBlockIndexFormat<BlockIdSlot>

Public / Attributes

Absolute

Does Location refer to an absolute file offset (true) or to a block ID (false)?

public readonly field	Absolute
type	bool

Location

Location of the 64-bit word that holds the block ID value.

public readonly field	Location
type	int64

Remarks:

This is either an absolute file offset (if Absolute is true) or a block ID (if Absolute is false).

Public / Methods

At

Creates a new instance of BlockIdSlot for an absolute file offset.

public static method	At (int64 fileOffset)
type	BlockIdSlot
params	fileOffset	[>=0]	The absolute file offset.
returns			The BlockIdSlot value.

Free

Frees the storage block (if any).

[BeginEnd]
public method	Free (BlockStorage storage)
params	storage	[not-null]	The block storage.

See also:

BlockStorage.BeginWrite

New

Creates a new instance of BlockIdSlot for a storage block.

[BeginEnd]
public static method	New (BlockStorage storage)
type	BlockIdSlot
params	storage	[not-null]	The block storage.
returns			The BlockIdSlot value.

See also:

BlockStorage.BeginWrite

Read

Reads the block index root node ID.

[BeginEnd]
public method	Read (BlockStorage storage)
type	int64
params	storage	[not-null]	The block storage.
returns			The block index root node ID.

ToString

public override method	ToString ()
type	string

Write

Writes the block index root node ID.

[BeginEnd]
public method	Write (BlockStorage storage, int64 rootId)
params	storage	[not-null]	The block storage.
	rootId		The block index root node ID.

See also:

BlockStorage.BeginWrite