Skip to main content

VidHeader

Struct VidHeader 

pub struct VidHeader {
    pub kind: VolumeKind,
    pub copy: bool,
    pub compat: u8,
    pub volume_id: u32,
    pub lnum: u32,
    pub data_size: u32,
    pub used_ebs: u32,
    pub data_pad: u32,
    pub data_crc: u32,
    pub sqnum: u64,
}
Expand description

Volume identifier header of an erase block that holds data.

It says which logical eraseblock of which volume the block holds.

Fields§

§kind: VolumeKind

Type of the volume.

§copy: bool

Whether wear leveling copied the block from another block.

§compat: u8

How UBI implementations that don’t know the volume treat it.

§volume_id: u32

ID of the volume.

§lnum: u32

Number of the logical eraseblock in the volume.

§data_size: u32

Bytes of data in the block. Only set for static volumes and copies.

§used_ebs: u32

Number of logical eraseblocks with data. Only set for static volumes.

§data_pad: u32

Bytes at the end of each block that alignment leaves unused.

§data_crc: u32

CRC of the data. Only set for static volumes and copies.

§sqnum: u64

Sequence number. If two blocks contain the same logical eraseblock, UBI uses the one with the higher number.

Implementations§

§

impl VidHeader

pub const SIZE: usize = HEADER_SIZE

Size of the header in bytes.

pub fn parse(data: &[u8]) -> Result<Self, FormatError>

Parses the header at the start of data.

It applies the checks of the kernel’s validate_vid_hdr that don’t depend on the size of the logical eraseblock. super::ImageReader applies the others.

§Errors

Returns an error if data is too short or a field has a value that the kernel rejects.

pub fn to_bytes(&self) -> [u8; 64]

Returns the header as stored on flash, with version 1 and its CRC.

pub(crate) const fn has_data_size(&self) -> bool

Returns whether the header stores the size and CRC of the data, as static volumes and copies do.

fn validate(&self) -> Result<(), FormatError>

Applies the rules of validate_vid_hdr that work without the size of the logical eraseblock.

Trait Implementations§

§

impl Clone for VidHeader

§

fn clone(&self) -> VidHeader

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
§

impl Copy for VidHeader

§

impl Debug for VidHeader

§

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

Formats the value using the given formatter. Read more
§

impl Eq for VidHeader

§

impl PartialEq for VidHeader

§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
§

impl StructuralPartialEq for VidHeader

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 = !

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.