hypercore 0.16.0

Secure, distributed, append-only log
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
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93

use std::fmt::Debug;
#[cfg(feature = "cache")]
use std::time::Duration;
use tracing::instrument;

#[cfg(feature = "cache")]
use crate::common::cache::CacheOptions;
use crate::{Hypercore, HypercoreError, PartialKeypair, Storage, core::HypercoreOptions};

/// Build CacheOptions.
#[cfg(feature = "cache")]
#[derive(Debug)]
pub struct CacheOptionsBuilder(CacheOptions);

#[cfg(feature = "cache")]
impl Default for CacheOptionsBuilder {
    fn default() -> Self {
        Self::new()
    }
}

#[cfg(feature = "cache")]
impl CacheOptionsBuilder {
    /// Create a CacheOptions builder with default options
    pub fn new() -> Self {
        Self(CacheOptions::new())
    }

    /// Set cache time to live.
    pub fn time_to_live(mut self, time_to_live: Duration) -> Self {
        self.0.time_to_live = Some(time_to_live);
        self
    }

    /// Set cache time to idle.
    pub fn time_to_idle(mut self, time_to_idle: Duration) -> Self {
        self.0.time_to_idle = Some(time_to_idle);
        self
    }

    /// Set cache max capacity in bytes.
    pub fn max_capacity(mut self, max_capacity: u64) -> Self {
        self.0.max_capacity = Some(max_capacity);
        self
    }

    /// Build new cache options.
    pub(crate) fn build(self) -> CacheOptions {
        self.0
    }
}

/// Build a Hypercore instance with options.
#[derive(Debug)]
pub struct HypercoreBuilder {
    storage: Storage,
    options: HypercoreOptions,
}

impl HypercoreBuilder {
    /// Create a hypercore builder with a given storage
    pub fn new(storage: Storage) -> Self {
        Self {
            storage,
            options: HypercoreOptions::new(),
        }
    }

    /// Set key pair.
    pub fn key_pair(mut self, key_pair: PartialKeypair) -> Self {
        self.options.key_pair = Some(key_pair);
        self
    }

    /// Set open.
    pub fn open(mut self, open: bool) -> Self {
        self.options.open = open;
        self
    }

    /// Set node cache options.
    #[cfg(feature = "cache")]
    pub fn node_cache_options(mut self, builder: CacheOptionsBuilder) -> Self {
        self.options.node_cache_options = Some(builder.build());
        self
    }

    /// Build a new Hypercore.
    #[instrument(err, skip_all)]
    pub async fn build(self) -> Result<Hypercore, HypercoreError> {
        Hypercore::new(self.storage, self.options).await
    }
}