I'm trying to get my small project, which is entirely displayed here:

use std::net::TcpStream;
use std::io::{Read, Write};


/// Reads network traffic sent by the send_network_traffic function. First,
/// a byte is sent denoting the number of byte sequences that will be read.
/// Next, the incoming byte count of the first section is received, followed
/// by the bytes being received. This happens for each section, until all
/// byte sequences are received. 
pub fn read_network_traffic(mut stream: TcpStream) -> Vec<Vec<u8>> {
    let mut byte_sequences = Vec::<Vec<u8>>::new();

    let mut section_count: [u8; 1] = [0; 1];

    match stream.read_exact(&mut section_count) {
        Ok(()) => {}
        Err(e) => panic!("Error: {:#?}", e),
    }

    while section_count[0] > 0 {
        section_count[0] -= 1;

        let mut incoming_byte_count: [u8; 8] = [0; 8];

        match stream.read_exact(&mut incoming_byte_count) {
            Ok(()) => {}
            Err(e) => panic!("Error: {:#?}", e),
        }

        let incoming = u64::from_be_bytes(incoming_byte_count);

        let mut incoming = usize::try_from(incoming).unwrap();

        let mut vec = vec![0; incoming];

        while incoming > 0 {
            incoming -= stream.read(&mut vec).unwrap();
        }

        byte_sequences.push(vec);
    }
    byte_sequences
}

/// Sends network traffic to the read_network_traffic function.
pub fn send_network_traffic(
    mut socket: TcpStream,
    byte_sequences: Vec<Vec<u8>>,
) -> TcpStream {
    // The section count is the length of the vector
    let section_count = byte_sequences.len();

    //transmit section count
        socket
        .write(&[section_count as u8])
        .unwrap();

    // transmit byte_sequences byte count
    for n in 0..section_count {
        let byte_sequences_len: [u8; 8] = byte_sequences[n as usize].len().to_be_bytes();
        
        socket.write(&byte_sequences_len).unwrap();
        
             socket
            .write(byte_sequences[n as usize].as_slice())
            .unwrap();
    }

    // return the connected stream
    socket
}

cargo.toml

[package]
name = "vec_router"
version = "0.0.2"
edition = "2024"

license = "MIT OR Apache-2.0"
description = "Networking code for sending and receiving vectors of vec<u8> on 64 bit systems"
keywords = ["networking"]

[dependencies]

To have documentation comments from crates.io. : crates.io: Rust Package Registry

but there is no documentation. Why isn't it showing the documentation comments above my two functions? I can view it locally with:

cargo doc --open

but there is no documentation link on the crates.io page.

Thanks for any help.

7 posts - 5 participants

Read full topic