Skip to main content

Configuration

Struct Configuration 

Source
pub struct Configuration { /* private fields */ }
Expand description

Fully resolved crawler configuration.

Unlike the interface’s non-optional storage getter, core exposes an optional client because it cannot depend on millipede-storage-memory without a dependency cycle. The crawler builder takes the client from CrawlerBuilder::storage_client or Configuration::storage_client and returns CrawlerBuildError::MissingStorage when neither is set; default in-memory wiring lives with the umbrella crate’s examples.

Implementations§

Source§

impl Configuration

Source

pub fn builder() -> ConfigurationBuilder

Creates an empty configuration builder.

Source

pub fn events(&self) -> &EventBus

Returns the crawler event bus.

Source

pub fn default_dataset_id(&self) -> &str

Returns the default dataset identifier.

Source

pub fn default_key_value_store_id(&self) -> &str

Returns the default key-value store identifier.

Source

pub fn default_request_queue_id(&self) -> &str

Returns the default request queue identifier.

Source

pub fn storage_dir(&self) -> &Path

Returns the storage directory.

Source

pub fn max_used_cpu_ratio(&self) -> Option<f32>

Returns the maximum used CPU ratio, when configured.

Source

pub fn available_memory_ratio(&self) -> Option<f32>

Returns the available memory ratio, when configured.

Source

pub fn memory_bytes(&self) -> Option<u64>

Returns the memory limit in bytes, when configured.

Source

pub fn persist_state_interval(&self) -> Duration

Returns the interval between state persistence events.

Source

pub fn purge_on_start(&self) -> bool

Returns whether storage is purged at startup.

Source

pub fn log_level(&self) -> LogLevel

Returns the logging verbosity.

Source

pub fn storage_client(&self) -> Option<&Arc<dyn StorageClient>>

Returns the configured storage client, when one was injected.

Trait Implementations§

Source§

impl Debug for Configuration

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Configuration

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more