documentation

Author: maxomatic458

qs-core/src/receive.rs

@@ -138,6 +138,7 @@ pub enum ReceiveError {
     ReceivePacket(#[from] PacketRecvError),
 }
 
+/// A receiver that can receive files
 pub struct Receiver {
     /// Receiver arguments
     args: ReceiverArgs,
@@ -147,6 +148,7 @@ pub struct Receiver {
     endpoint: Endpoint,
 }
 
+/// Arguments for the receiver
 pub struct ReceiverArgs {
     /// Resume interrupted transfer
     pub resume: bool,

qs-core/src/send.rs

@@ -1,7 +1,6 @@
 #![allow(clippy::suspicious_open_options)]
 
 use std::{
-    io,
     net::{SocketAddr, UdpSocket},
     path::PathBuf,
 };
@@ -116,6 +115,7 @@ pub enum SendError {
     ReceivePacket(#[from] PacketRecvError),
 }
 
+/// A client that can send files
 pub struct Sender {
     /// Sender arguments
     args: SenderArgs,
@@ -125,6 +125,7 @@ pub struct Sender {
     endpoint: Endpoint,
 }
 
+/// Arguments for the sender
 pub struct SenderArgs {
     /// Files/Directories to send
     pub files: Vec<PathBuf>,