Struct Leader 

pub struct Leader<'a> { /* private fields */ }

Leader of stream protocol.

Example

use cameleon_device::u3v::protocol::stream::{Leader, PayloadType, ImageLeader,
                                            ImageExtendedChunkLeader, ChunkLeader};

// Buffer for leader bytes.
let mut buf = Vec::new();

// Fill buffer using [`cameleon_device::u3v::Device`].
// ..

// Parse leader. In this point, only the generic part of the leader is parsed.
let leader = Leader::parse(&buf).unwrap();

// Parse a specific part of the leader.
match leader.payload_type() {
    PayloadType::Image => {
        // Try parsing specific part as Image Leader.
        let image_leader: ImageLeader = leader.specific_leader_as().unwrap();
    }
    PayloadType::ImageExtendedChunk => {
        // Try parsing specific part as Image Extended Chunk Leader.
        let image_leader: ImageExtendedChunkLeader = leader.specific_leader_as().unwrap();
    }

    PayloadType::Chunk => {
        // Try parsing specific part as Image Extended Chunk Leader.
        let image_leader: ChunkLeader = leader.specific_leader_as().unwrap();
    }
}

Implementations

impl<'a> Leader<'a>

pub fn parse(buf: &'a (impl AsRef<[u8]> + ?Sized)) -> Result<Self>

Parse bytes as Leader.

pub fn specific_leader_as<T: SpecificLeader>(&self) -> Result<T>

Return a specific part of leader.

Example

                                            ImageExtendedChunkLeader, ChunkLeader};
let leader = Leader::parse(&buf).unwrap();
// Parse a specific part of the leader.
match leader.payload_type() {
    PayloadType::Image => {
        // Try parsing specific part as Image Leader.
        let image_leader: ImageLeader = leader.specific_leader_as().unwrap();
    }
    PayloadType::ImageExtendedChunk => {
        // Try parsing specific part as Image Extended Chunk Leader.
        let image_leader: ImageExtendedChunkLeader = leader.specific_leader_as().unwrap();
    }

    PayloadType::Chunk => {
        // Try parsing specific part as Image Extended Chunk Leader.
        let image_leader: ChunkLeader = leader.specific_leader_as().unwrap();
    }
}

pub fn leader_size(&self) -> u16

Total size of leader, this size contains a specific leader part.

pub fn payload_type(&self) -> PayloadType

Type of the payload the leader is followed by.

pub fn block_id(&self) -> u64

ID of data block.

Trait Implementations

impl<'a> Clone for Leader<'a>

fn clone(&self) -> Leader<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Leader<'a>

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

Formats the value using the given formatter.