SnapDB Library
Sub
This contains the meta data of the file along with index information to map all of the blocks of the file.
Definition
Namespace: SnapDB.IO.FileStructure
Assembly: SnapDB (in SnapDB.dll) Version: 1.0.102.0 -- Release Build+29075351d0e5aa4dea46a5c520805222f672dc2e
Assembly: SnapDB (in SnapDB.dll) Version: 1.0.102.0 -- Release Build+29075351d0e5aa4dea46a5c520805222f672dc2e
C#
public class SubFileHeader : ImmutableObjectAutoBase<SubFileHeader>VB
Public Class SubFileHeader
Inherits ImmutableObjectAutoBase(Of SubFileHeader)C++
public ref class SubFileHeader : public ImmutableObjectAutoBase<SubFileHeader^>JavaScript
SnapDB.IO.FileStructure.SubFileHeader = function();
Type.createClass(
'SnapDB.IO.FileStructure.SubFileHeader',
SnapDB.Immutables.ImmutableObjectAutoBase`1);- Inheritance
- Object ImmutableObjectBaseSubFileHeader ImmutableObjectAutoBaseSubFileHeader SubFileHeader
Constructors
| SubFileHeader(BinaryReader, Boolean, Boolean) | Creates a SubFileHeader from the data stream. |
| SubFileHeader(UInt16, SubFileName, Boolean, Boolean) | Creates a new SubFileHeader. |
Properties
| DataBlockCount | Gets the number of blocks the data portion of this file contains. |
| DirectBlock | Gets the block address for the first direct block of this file. |
| DoubleIndirectBlock | Gets the block address for the double indirect block. |
| FileIdNumber | Gets the unique file identifier for this file. |
| FileName | Gets the SubFileName that represents what type of data is contained in this file. |
| IsReadOnly |
Gets or sets if this class is immutable and thus read-only. Once
setting to read-only, the class becomes immutable.
(Inherited from ImmutableObjectBaseT) |
| QuadrupleIndirectBlock | Gets the block address for the quadruple indirect block. |
| SingleIndirectBlock | Gets the block address for the single indirect block. |
| TotalBlockCount | Gets the total number of blocks that has been used by this file. This includes meta data blocks and previous version blocks. |
| TripleIndirectBlock | Gets the block address for the triple indirect block. |
Methods
| Clone |
Creates a clone of the object, either as a read-only instance or an editable one.
(Inherited from ImmutableObjectBaseT) |
| CloneEditable |
Creates a clone of this class that is editable.
A clone is always created, even if this class is already editable.
(Inherited from ImmutableObjectBaseT) |
| CloneMembersAsEditable |
Request that member fields be cloned and marked as editable.
(Inherited from ImmutableObjectAutoBaseT) |
| CloneReadonly |
Creates a read-only clone of the object.
(Inherited from ImmutableObjectBaseT) |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object) |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
| Save | Writes the data contained in SubFileHeader to the data stream. |
| SetMembersAsReadOnly |
Requests that member fields be set to "read-only".
(Inherited from ImmutableObjectAutoBaseT) |
| TestForEditable |
Test if the class has been marked as read-only. Throws an exception if editing cannot occur.
(Inherited from ImmutableObjectBaseT) |
| ToString | Returns a string that represents the current object. (Inherited from Object) |