Skip to main content

CrawlConfig

Struct CrawlConfig 

Source
pub struct CrawlConfig {
Show 14 fields pub max_depth: u16, pub scope: CrawlScope, pub max_pages: usize, pub min_delay: Duration, pub max_bytes: Option<u64>, pub user_agent: Option<CompactString>, pub require_path_contains: Vec<CompactString>, pub accept_extensions: Vec<CompactString>, pub index_path_contains: Vec<CompactString>, pub concurrency: usize, pub max_retries: u32, pub validators: HashMap<UrlKey, CompactString>, pub known_edges: HashMap<UrlKey, Vec<Url>>, pub respect_robots: bool,
}
Expand description

Crawl configuration. Every field is honored; see CrawlSource builder methods.

Fields§

§max_depth: u16

Maximum link depth from the root (root is depth 0).

§scope: CrawlScope

Which links to follow.

§max_pages: usize

Hard cap on total pages fetched (runaway guard).

§min_delay: Duration

Polite delay between fetches.

§max_bytes: Option<u64>

Per-page byte ceiling.

§user_agent: Option<CompactString>

User-Agent override.

§require_path_contains: Vec<CompactString>

A followed link’s URL path must contain all of these substrings (empty = no constraint). Composes with CrawlConfig::scope: use it to confine a crawl to a sub-path that the host’s URL scheme splits across segments (e.g. GitHub’s /tree/ directories and /blob/ files both under /main/docs).

§accept_extensions: Vec<CompactString>

Only index pages whose URL path ends with one of these extensions, e.g. ["md"] (empty = index every indexable kind). Non-matching pages are still crawled for links — only their indexing is filtered.

§index_path_contains: Vec<CompactString>

Only index pages whose URL path contains all of these substrings (empty = no constraint). Independent of CrawlConfig::require_path_contains: follow broadly, index narrowly — e.g. follow GitHub /tree/ dirs but index only the canonical /blob/ file views, collapsing the /raw/,/commits/ duplicates.

§concurrency: usize

Maximum fetches in flight at once (clamped to at least 1). Higher values crawl faster; min_delay still paces request starts globally.

§max_retries: u32

Retry budget per page for retriable errors (timeouts, 429/5xx). Honors Retry-After on rate limits; other retries back off exponentially.

§validators: HashMap<UrlKey, CompactString>

Known entity tags by canonical-URL key: fetches send If-None-Match and a 304 skips the body transfer entirely (conditional re-crawl).

§known_edges: HashMap<UrlKey, Vec<Url>>

Known outbound links by canonical-URL key: when a page revalidates as unchanged (no body to parse), its previously indexed children keep the frontier going, so coverage never shrinks on a 304.

§respect_robots: bool

Fetch and honor robots.txt per host (opt-in; requires the robots feature).

Trait Implementations§

Source§

impl Clone for CrawlConfig

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for CrawlConfig

Source§

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

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

impl Default for CrawlConfig

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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