Struct BcpHeader 

pub struct BcpHeader {
    pub version_major: u8,
    pub version_minor: u8,
    pub flags: HeaderFlags,
}

BCP file header — the first 8 bytes of every payload.

┌────────┬─────────┬──────────────────────────────────┐
│ Offset │ Size    │ Description                      │
├────────┼─────────┼──────────────────────────────────┤
│ 0x00   │ 4 bytes │ Magic: "BCP\0" (0x42435000)      │
│ 0x04   │ 1 byte  │ Version major                    │
│ 0x05   │ 1 byte  │ Version minor                    │
│ 0x06   │ 1 byte  │ Flags                            │
│ 0x07   │ 1 byte  │ Reserved (0x00)                  │
└────────┴─────────┴──────────────────────────────────┘

Fields

version_major: u8

version_minor: u8

flags: HeaderFlags

Implementations

impl BcpHeader

pub fn new(flags: HeaderFlags) -> Self

Create a new header with the current version and the given flags.

pub fn write_to(&self, buf: &mut [u8]) -> Result<(), WireError>

Write the 8-byte header into the provided buffer.

Errors

Returns WireError::UnexpectedEof if buf is shorter than HEADER_SIZE (8 bytes).

pub fn read_from(buf: &[u8]) -> Result<Self, WireError>

Parse a header from the first 8 bytes of the provided buffer.

Errors

• WireError::UnexpectedEof if buffer is too short.
• WireError::InvalidMagic if the magic number doesn’t match.
• WireError::UnsupportedVersion if the major version is unknown.
• WireError::ReservedNonZero if the reserved byte is not 0x00.

Trait Implementations

impl Clone for BcpHeader

fn clone(&self) -> BcpHeader

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BcpHeader

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

Formats the value using the given formatter.

impl PartialEq for BcpHeader

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for BcpHeader

impl StructuralPartialEq for BcpHeader