CrawlOptions

firecrawl_sdk::crawl

Struct CrawlOptions

pub struct CrawlOptions {
    pub scrape_options: Option<ScrapeOptions>,
    pub include_paths: Option<Vec<String>>,
    pub exclude_paths: Option<Vec<String>>,
    pub max_depth: Option<u32>,
    pub ignore_sitemap: Option<bool>,
    pub limit: Option<u32>,
    pub allow_backward_links: Option<bool>,
    pub allow_external_links: Option<bool>,
    pub deduplicate_similar_urls: Option<bool>,
    pub ignore_query_parameters: Option<bool>,
}

Fields§

§scrape_options: Option<ScrapeOptions>

Options for scraping each page

§include_paths: Option<Vec<String>>

Only crawl these URL paths

§exclude_paths: Option<Vec<String>>

URL paths to exclude from crawling

§max_depth: Option<u32>

Maximum link depth to crawl. (default: 2)

§ignore_sitemap: Option<bool>

Skip sitemap.xml discovery. (default: true)

§limit: Option<u32>

Maximum number of pages to crawl. (default: 10)

§allow_backward_links: Option<bool>

Allow crawling links that point to parent directories. (default: false)

§allow_external_links: Option<bool>

Allow crawling links to external domains. (default: false)

§deduplicate_similar_urls: Option<bool>

Remove similar URLs during crawl

§ignore_query_parameters: Option<bool>

Ignore query parameters when comparing URLs

Trait Implementations§

impl Clone for CrawlOptions

fn clone(&self) -> CrawlOptions

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

impl Debug for CrawlOptions

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

Formats the value using the given formatter. Read more

impl Default for CrawlOptions

fn default() -> CrawlOptions

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

impl<'de> Deserialize<'de> for CrawlOptions

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

impl Serialize for CrawlOptions

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

impl Freeze for CrawlOptions

impl RefUnwindSafe for CrawlOptions

impl Send for CrawlOptions

impl Sync for CrawlOptions

impl Unpin for CrawlOptions

impl UnwindSafe for CrawlOptions

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

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

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

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

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

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

fn in_current_span(self) -> Instrumented<Self>

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

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

fn into(self) -> U

Calls U::from(self).

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

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

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: 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

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: 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

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

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

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<T> WithSubscriber for T

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

fn with_current_subscriber(self) -> WithDispatch<Self>

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

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

impl<T> ErasedDestructor for T
where T: 'static,