Struct zff::header::version1::SegmentHeader

pub struct SegmentHeader { /* private fields */ }

The segment header contains all informations about the specific segment. Each segment has his own segment header.
This header is not a part of the main header.\

Implementations

impl SegmentHeader

pub fn new_empty(
    version: u8,
    unique_identifier: i64,
    segment_number: u64
) -> SegmentHeader

returns a new empty segment header

pub fn new(
    version: u8,
    unique_identifier: i64,
    segment_number: u64,
    length_of_segment: u64,
    footer_offset: u64
) -> SegmentHeader

returns a new segment header with the given values.

pub fn unique_identifier(&self) -> i64

returns the unique identifier of image (each segment should have the same identifier).

pub fn segment_number(&self) -> u64

returns the segment number.

pub fn length_of_segment(&self) -> u64

returns the length of the segment in bytes.

pub fn set_length_of_segment(&mut self, value: u64)

overwrites the length value in the header with the given value. This can be useful, if you create an ‘empty’ header (with length=0) and want to set the length value after reading the data from source to buffer.

pub fn next_header(&self) -> SegmentHeader

sets the segment number to the next number. This can be useful, for example, if you clone a segment header from the previous one or something like that.

pub fn set_footer_offset(&mut self, offset: u64)

sets the offset of the segment footer.

pub fn footer_offset(&self) -> u64

returns the footer offset.

Trait Implementations

impl Clone for SegmentHeader

fn clone(&self) -> SegmentHeader

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SegmentHeader

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl HeaderCoding for SegmentHeader

type Item = SegmentHeader

the return value for decode_content(), decode_directly(), decode_for_key();

fn identifier() -> u32

returns the identifier (=Magic bytes) of the header.

fn version(&self) -> u8

returns the version of the header.

fn encode_header(&self) -> Vec<u8>

encodes the header.

fn decode_content(data: Vec<u8>) -> Result<SegmentHeader>

decodes the content of the header.

fn header_size(&self) -> usize

returns the size of the encoded header (in bytes)

fn encode_key<K: Into<String>>(key: K) -> Vec<u8>

encodes a given key.

fn encode_directly(&self) -> Vec<u8>

encodes the (header) value/object directly (= without key).

fn encode_for_key<K: Into<String>>(&self, key: K) -> Vec<u8>

encodes a key to the (header) value/object.

fn decode_header_length<R: Read>(data: &mut R) -> Result<u64>

decodes the length of the header.

fn check_identifier<R: Read>(data: &mut R) -> bool

checks if the read identifier is valid for this header.

fn check_key_on_position<K: Into<String>, R: Read>(data: &mut R, key: K) -> bool

helper method to check, if the key is on position.

fn decode_directly<R: Read>(data: &mut R) -> Result<Self::Item>

decodes the header directly.

fn decode_for_key<K: Into<String>, R: Read>(
    data: &mut R,
    key: K
) -> Result<Self::Item>

decodes the header for the given key.

impl PartialEq<SegmentHeader> for SegmentHeader

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl Eq for SegmentHeader

impl StructuralEq for SegmentHeader