Struct inspect_format::HeaderFields

pub struct HeaderFields;

Bitfields for writing and reading segments of the header and payload of inspect VMO blocks. Represents the header structure of an inspect VMO Block. Not to confuse with the HEADER block.

Implementations

impl HeaderFields

pub fn order<T: Deref<Target = Q>, Q: ReadBytes>(b: &Block<T>) -> u8

The size of a block given as a bit shift from the minimum size. size_in_bytes = 16 << order. Separates blocks into classes by their (power of two) size.

pub fn set_order<T: Deref<Target = Q> + DerefMut<Target = Q>, Q: WriteBytes + ReadBytes>( b: &mut Block<T>, value: u8 )

The size of a block given as a bit shift from the minimum size. size_in_bytes = 16 << order. Separates blocks into classes by their (power of two) size.

pub fn block_type<T: Deref<Target = Q>, Q: ReadBytes>(b: &Block<T>) -> u8

The type of the block. Determines how the rest of the bytes are interpreted.

• 0: Free
• 1: Reserved
• 2: Header
• 3: Node
• 4: Int value
• 5: Uint value
• 6: Double value
• 7: Buffer value
• 8: Extent
• 9: Name
• 10: Tombstone
• 11: Array value
• 12: Link value
• 13: Bool value
• 14: String Reference

pub fn set_block_type<T: Deref<Target = Q> + DerefMut<Target = Q>, Q: WriteBytes + ReadBytes>( b: &mut Block<T>, value: u8 )

The type of the block. Determines how the rest of the bytes are interpreted.

• 0: Free
• 1: Reserved
• 2: Header
• 3: Node
• 4: Int value
• 5: Uint value
• 6: Double value
• 7: Buffer value
• 8: Extent
• 9: Name
• 10: Tombstone
• 11: Array value
• 12: Link value
• 13: Bool value
• 14: String Reference

pub fn header_version<T: Deref<Target = Q>, Q: ReadBytes>(b: &Block<T>) -> u32

Only for a HEADER block. The version number. Currently 1.

pub fn set_header_version<T: Deref<Target = Q> + DerefMut<Target = Q>, Q: WriteBytes + ReadBytes>( b: &mut Block<T>, value: u32 )

Only for a HEADER block. The version number. Currently 1.

pub fn header_magic<T: Deref<Target = Q>, Q: ReadBytes>(b: &Block<T>) -> u32

Only for a HEADER block. The magic number “INSP”.

pub fn set_header_magic<T: Deref<Target = Q> + DerefMut<Target = Q>, Q: WriteBytes + ReadBytes>( b: &mut Block<T>, value: u32 )

Only for a HEADER block. The magic number “INSP”.

pub fn value_name_index<T: Deref<Target = Q>, Q: ReadBytes>(b: &Block<T>) -> u32

Only for *_VALUE blocks. The index of the NAME block of associated with this value.

pub fn set_value_name_index<T: Deref<Target = Q> + DerefMut<Target = Q>, Q: WriteBytes + ReadBytes>( b: &mut Block<T>, value: u32 )

Only for *_VALUE blocks. The index of the NAME block of associated with this value.

pub fn value_parent_index<T: Deref<Target = Q>, Q: ReadBytes>( b: &Block<T> ) -> u32

Only for *_VALUE blocks. The index of the parent of this value.

pub fn set_value_parent_index<T: Deref<Target = Q> + DerefMut<Target = Q>, Q: WriteBytes + ReadBytes>( b: &mut Block<T>, value: u32 )

Only for *_VALUE blocks. The index of the parent of this value.

pub fn reserved_empty<T: Deref<Target = Q>, Q: ReadBytes>(b: &Block<T>) -> u64

pub fn set_reserved_empty<T: Deref<Target = Q> + DerefMut<Target = Q>, Q: WriteBytes + ReadBytes>( b: &mut Block<T>, value: u64 )

pub fn tombstone_empty<T: Deref<Target = Q>, Q: ReadBytes>(b: &Block<T>) -> u64

pub fn set_tombstone_empty<T: Deref<Target = Q> + DerefMut<Target = Q>, Q: WriteBytes + ReadBytes>( b: &mut Block<T>, value: u64 )

pub fn free_reserved<T: Deref<Target = Q>, Q: ReadBytes>(b: &Block<T>) -> u8

Only for FREE blocks. The index of the next free block.

pub fn set_free_reserved<T: Deref<Target = Q> + DerefMut<Target = Q>, Q: WriteBytes + ReadBytes>( b: &mut Block<T>, value: u8 )

Only for FREE blocks. The index of the next free block.

pub fn free_next_index<T: Deref<Target = Q>, Q: ReadBytes>(b: &Block<T>) -> u32

pub fn set_free_next_index<T: Deref<Target = Q> + DerefMut<Target = Q>, Q: WriteBytes + ReadBytes>( b: &mut Block<T>, value: u32 )

pub fn free_empty<T: Deref<Target = Q>, Q: ReadBytes>(b: &Block<T>) -> u32

pub fn set_free_empty<T: Deref<Target = Q> + DerefMut<Target = Q>, Q: WriteBytes + ReadBytes>( b: &mut Block<T>, value: u32 )

pub fn name_length<T: Deref<Target = Q>, Q: ReadBytes>(b: &Block<T>) -> u16

Only for NAME blocks. The length of the string.

pub fn set_name_length<T: Deref<Target = Q> + DerefMut<Target = Q>, Q: WriteBytes + ReadBytes>( b: &mut Block<T>, value: u16 )

Only for NAME blocks. The length of the string.

pub fn extent_next_index<T: Deref<Target = Q>, Q: ReadBytes>( b: &Block<T> ) -> u32

Only for EXTENT or STRING_REFERENCE blocks. The index of the next EXTENT block.

pub fn set_extent_next_index<T: Deref<Target = Q> + DerefMut<Target = Q>, Q: WriteBytes + ReadBytes>( b: &mut Block<T>, value: u32 )

Only for EXTENT or STRING_REFERENCE blocks. The index of the next EXTENT block.

pub fn string_reference_count<T: Deref<Target = Q>, Q: ReadBytes>( b: &Block<T> ) -> u32

Only for STRING_REFERENCE blocks. The number of active references to the string, including itself.

pub fn set_string_reference_count<T: Deref<Target = Q> + DerefMut<Target = Q>, Q: WriteBytes + ReadBytes>( b: &mut Block<T>, value: u32 )

Only for STRING_REFERENCE blocks. The number of active references to the string, including itself.

pub fn value<T: Deref<Target = Q>, Q: ReadBytes>(b: &Block<T>) -> u64

Get the raw 64 bits of the header section of the block.

pub fn set_value<T: Deref<Target = Q> + DerefMut<Target = Q>, Q: WriteBytes + ReadBytes>( b: &mut Block<T>, value: u64 )

Set the raw 64 bits of the header section of the block.