Struct Window

pub struct Window { /* private fields */ }

Window struct is used to store chunks of data from a file. It is used to help store the data that is being sent or received for the RFC 7440 Windowsize option.

Example

use std::{fs::{self, OpenOptions, File}, io::Write};
use tftpd::Window;

let mut file = File::create("test.txt").unwrap();
file.write_all(b"Hello, world!").unwrap();
file.flush().unwrap();

let file = File::open("test.txt").unwrap();
let mut window = Window::new(5, 512, file);
window.fill().unwrap();
fs::remove_file("test.txt").unwrap();

Implementations

impl Window

pub fn new(size: u16, chunk_size: usize, file: File) -> Window

Creates a new Window with the supplied size and chunk size.

pub fn fill(&mut self) -> Result<bool, Box<dyn Error>>

Fills the Window with chunks of data from the file. Returns true if the Window is full.

pub fn empty(&mut self) -> Result<(), Box<dyn Error>>

Empties the Window by writing the data to the file.

pub fn remove(&mut self, amount: u16) -> Result<(), &'static str>

Removes the first amount of elements from the Window.

pub fn add(&mut self, data: Vec<u8>) -> Result<(), &'static str>

Adds a data Vec<u8> to the Window.

pub fn get_elements(&self) -> &VecDeque<Vec<u8>>

Returns a reference to the VecDeque containing the elements.

pub fn len(&self) -> u16

Returns the length of the Window.

pub fn is_empty(&self) -> bool

Returns true if the Window is empty.

pub fn is_full(&self) -> bool

Returns true if the Window is full.

pub fn file_len(&self) -> Result<usize, Box<dyn Error>>

Returns the length of the file