Struct portal_lib::file::PortalFile

pub struct PortalFile {
    pub mmap: MmapMut,
    pub cipher: ChaCha20Poly1305,
    // some fields omitted
}

A file mapping that contains state to encrypt/decrypt files in memory

Fields

mmap: MmapMut

cipher: ChaCha20Poly1305

Implementations

impl PortalFile

pub fn init(mmap: MmapMut, cipher: ChaCha20Poly1305) -> PortalFile

pub fn encrypt(&mut self) -> Result<()>

Encrypts the current PortalFile, by encrypting the mmap'd memory in-place

pub fn decrypt(&mut self) -> Result<()>

Decrypts the current PortalFile, by decrypting the mmap'd memory in-place

pub fn sync_file_state<W>(&mut self, writer: W) -> Result<usize> where
    W: Write, 

Writes the nonce and tag for this file to the provided writer. Use after encrypting a file to communicate state data to the peer that will decrypt the file

pub fn download_file<R, F>(&mut self, reader: R, callback: F) -> Result<u64> where
    R: Read,
    F: Fn(u64), 

Downloads a file, first by retrieving the Tag and Nonce communicated by sync_file_state() and then reading in the file until EOF

Peer A                  Peer B
encrypt()               download_file()
sync_file_state()       decrypt()
// send chunks

pub fn get_chunks<'a>(
    &'a self,
    chunk_size: usize
) -> impl Iterator<Item = &'a [u8]>

Returns an iterator over the chunks to send it over the network

Examples

for data in file.get_chunks(portal::CHUNK_SIZE) {
     client.write_all(&data)?
     total += data.len();
     pb.set_position(total as u64);
}

pub fn write_given_chunk(&mut self, data: &[u8]) -> Result<u64>

Writes the provided data to the file in-memory at the current position