remozipsy 0.0.2

zip implementation independent structs and helpers
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46

use core::fmt::Debug;

mod compare;
mod download;
mod handle_processor;
mod remote;
mod state;

use super::{FileSystem, RemoteZip};
use crate::{
    model::{Config, Progress},
    proto::sync::{
        download::{DownloadResult, UnzipResult},
        state::State,
    },
};

/// main struct to sync remote with local via [`Self::progress`].
#[derive(Debug)]
pub struct Statemachine<R: RemoteZip, F: FileSystem> {
    internal: State<R, F>,
}

impl<R, F> Statemachine<R, F>
where
    R: RemoteZip + Clone + Send + 'static,
    F: FileSystem + Clone + Send + 'static,
{
    pub fn new(remote: R, file_system: F, config: Config) -> Self {
        Self {
            internal: State::ToBeEvaluated(remote, file_system, config),
        }
    }

    /// This is the `fn` that advances this state-machine.
    /// On call it will evaluate a small step towards completion and returns a
    /// progress afterwards.
    ///
    /// Usage: call it in a loop and present status to user.
    pub async fn progress(self) -> Option<(Progress<R::Error, F::Error>, Self)> {
        self.internal
            .progress()
            .await
            .map(|(progress, internal)| (progress, Self { internal }))
    }
}