Struct bogrep::Settings

pub struct Settings {
    pub sources: Vec<RawSource>,
    pub ignored_urls: Vec<String>,
    pub underlying_urls: Vec<String>,
    pub cache_mode: CacheMode,
    pub max_concurrent_requests: usize,
    pub request_timeout: u64,
    pub request_throttling: u64,
    pub max_idle_connections_per_host: usize,
    pub idle_connections_timeout: u64,
}

Describes the settings used in Bogrep.

Fields

sources: Vec<RawSource>

The paths to the configured bookmark files.

Source could be Firefox or Chrome.

ignored_urls: Vec<String>

The urls which are ignored and not imported.

underlying_urls: Vec<String>

Fetch the underlying for the given urls.

cache_mode: CacheMode

The file extension used to cache websites.

max_concurrent_requests: usize

The maximal number of concurrent requests.

request_timeout: u64

The request timeout in milliseconds.

request_throttling: u64

The throttling between requests in milliseconds.

max_idle_connections_per_host: usize

The maximum number of idle connections allowed in the connection pool.

idle_connections_timeout: u64

The timeout for idle connections to be kept alive in milliseconds.

Implementations

impl Settings

pub fn new( sources: Vec<RawSource>, ignored_urls: Vec<String>, underlying_urls: Vec<String>, cache_mode: CacheMode, max_concurrent_requests: usize, request_timeout: u64, request_throttling: u64, max_idle_connections_per_host: usize, idle_connections_timeout: u64 ) -> Self

pub fn init(settings_path: &Path) -> Result<Settings, Error>

pub fn add_ignored_url(&mut self, url: &str) -> Result<(), Error>

pub fn add_underlying_url(&mut self, url: &str) -> Result<(), Error>

pub fn set_source(&mut self, source: RawSource) -> Result<(), Error>

pub fn set_cache_mode(&mut self, cache_mode: Option<CacheMode>)

Trait Implementations

impl Clone for Settings

fn clone(&self) -> Settings

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Settings

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Settings

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Settings

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Settings

fn eq(&self, other: &Settings) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Settings

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Settings