Skip to main content

SectionHeader

Struct SectionHeader 

Source
pub struct SectionHeader {
    pub pointer: u64,
    pub csize: u32,
    pub size: u32,
    pub chksum: u32,
    pub btype: u8,
    pub flags: u8,
}
Expand description

The BPX Section Header.

Fields§

§pointer: u64

Data pointer.

Offset: +0

§csize: u32

Size in bytes after compression.

Offset: +8

§size: u32

Size in bytes before compression.

Offset: +12

§chksum: u32

Data checksum.

Offset: +16

§btype: u8

Type byte.

Offset: +20

§flags: u8

Flags (see FLAG_* constants).

Offset: +21

Implementations§

Source§

impl SectionHeader

Source

pub fn read<TReader: Read>(reader: &mut TReader) -> Result<(u32, SectionHeader)>

Attempts to read a BPX Section Header from an IO backend.

§Arguments
  • reader: the IO backend to read from.

returns: Result<(u32, SectionHeader), Error>

§Errors

Returns an Error if the data could not be read from the IO backend.

Source

pub fn new() -> SectionHeader

Creates a new empty BPX Section Header.

Source

pub fn is_huge_section(&self) -> bool

Checks if this section is huge (greater than 100Mb).

Source

pub fn get_checksum(&self) -> u32

Computes the checksum for this header.

Source

pub fn write<TWriter: Write>(&self, writer: &mut TWriter) -> Result<()>

Attempts to write this header to an IO backend.

§Arguments
  • writer: the IO backend to write to.

returns: Result<(), Error>

§Errors

Returns an Error if the data could not be written to the IO backend.

Trait Implementations§

Source§

impl Clone for SectionHeader

Source§

fn clone(&self) -> SectionHeader

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for SectionHeader

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.