Struct blob_stream::in_logic_front::FrontLogic

pub struct FrontLogic { /* private fields */ }

Logic handles the logic for receiving and processing chunks of data in a streaming context. It manages the internal state and interactions between the sender and receiver commands.

Implementations

impl FrontLogic

pub const fn new() -> Self

Creates a new InLogicFront instance with the specified octet_count and chunk_size.

Arguments

• octet_count - The total number of octets (bytes) expected in the stream.
• chunk_size - The size of each chunk in the stream.

Returns

A new InLogicFront instance.

pub fn update( &mut self, command: &SenderToReceiverFrontCommands, ) -> Result<ReceiverToSenderFrontCommands>

Updates the internal state based on a SenderToReceiverFrontCommands command.

This method processes either a StartTransfer or SetChunk command sent by the sender. If a StartTransfer command is received, the current state (including transfer_id and logic) is reinitialized if necessary. If a SetChunk command is received, it applies the chunk of data to the current logic.

Arguments

• command - A command sent by the sender to either start a new transfer or update an existing one with a chunk of data.

Returns

On success, this method returns a corresponding response:

• If a StartTransfer command is processed, it returns AckStart with the transfer_id.
• If a SetChunk command is processed successfully, it returns AckChunk with information on the last chunk received in order as well as a receive-mask for up to 64 chunks after that.

Errors

This function returns an io::Error in the following cases:

• If a SetChunk command is received and the transfer state has not been initialized (i.e., no StartTransfer has been processed), it returns an io::Error with ErrorKind::InvalidData and a message indicating that the transfer_id is unknown.

• Any I/O error encountered during the update of the logic will be propagated.

Example

use blob_stream::in_logic_front::FrontLogic;
use blob_stream::protocol::StartTransferData;
use blob_stream::protocol_front::SenderToReceiverFrontCommands;

let mut logic_front = FrontLogic::new();

let start_command = SenderToReceiverFrontCommands::StartTransfer(StartTransferData {
    transfer_id: 1234,
    total_octet_size: 1024,
    chunk_size: 256,
});

let response = logic_front.update(&start_command);
assert!(response.is_ok());

pub fn blob(&self) -> Option<&[u8]>

Retrieves the full blob data if all chunks have been received.

Returns

An Some(&[u8]) containing the full blob data if all chunks have been received, or None if the blob is incomplete.

pub fn info(&self) -> Option<Info>

Trait Implementations

impl Debug for FrontLogic

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

Formats the value using the given formatter.

impl Default for FrontLogic

fn default() -> FrontLogic

Returns the “default value” for a type.