aleym_core 0.1.0-alpha.1

Extensible news aggregation and knowledge-base engine (Core Library Component of Aleym)
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

//! # Aleym (Core Library)
//!
//! Core library powering Aleym knowledge base and news aggregation system.
//!
//! ## Feature flags
//!
//! * `full` -- build with all features enabled
//! * `net_interface_clear` (default) -- build with support for clear interface to the internet
//! * `net_interface_tor` -- build with support for Tor interface
//! * `net_transport_tls` -- build with TLS encryption support (e.g. for HTTPS)
//! * `net_protocol_http1` (default) -- HTTP/1.1 support
//! * `net_protocol_http2` (default) -- HTTP/2 support
//! * `informant_feedrs` -- build with support for RSS, ATOM, and JSON feeds

pub mod db;
mod error;
#[cfg(feature = "_informant")]
mod impl_scheduler;
pub mod inform;
pub mod ml;
pub mod net;

pub use error::Error;
#[cfg(feature = "_informant")]
pub use impl_scheduler::Event;

pub struct Representative {
	// TODO: Consider if this should be exposed directly or not.
	pub storage: db::StorageConnection,
	#[allow(unused)]
	network: net::Network,
	#[cfg(feature = "_informant")]
	events_sender: Option<tokio::sync::mpsc::UnboundedSender<Event>>,
}

impl Representative {
	pub async fn new(database_file: Option<&std::path::Path>) -> Result<Self, Error> {
		tracing::trace!("initializing new Aleym Representative");

		Ok(Self {
			storage: db::StorageConnection::new(database_file).await?,
			network: net::Network::new().await?,
			#[cfg(feature = "_informant")]
			events_sender: None,
		})
	}
}