Skip to main content

ItemList

Struct ItemList 

Source
pub struct ItemList(/* private fields */);
Expand description

A collection of scraped JSON items with serialization helpers.

ItemList wraps a Vec<serde_json::Value> and adds convenience methods for writing the collected data to disk as JSON or JSON Lines. It implements IntoIterator, Index, and the standard len / is_empty API so you can treat it like a regular collection.

Implementations§

Source§

impl ItemList

Source

pub fn new() -> Self

Creates an empty item list. This is equivalent to ItemList::default() and is what the crawler engine uses at the start of every crawl run.

Source

pub fn push(&mut self, item: Value)

Appends a JSON item to the list. The engine calls this for every item that passes through Spider::on_scraped_item without being dropped.

Source

pub fn len(&self) -> usize

Returns the number of items in the list.

Source

pub fn is_empty(&self) -> bool

Returns true if the list contains no items.

Source

pub fn iter(&self) -> Iter<'_, Value>

Returns an iterator over the items.

Source

pub fn to_json(&self, path: &Path, indent: bool) -> Result<()>

Writes all items to a JSON file at path, optionally pretty-printed. Parent directories are created automatically if they do not exist. Pass indent: true for human-readable output or false for compact output.

Source

pub fn to_jsonl(&self, path: &Path) -> Result<()>

Writes all items to a JSON Lines file (one JSON object per line). This format is convenient for streaming ingestion into data pipelines because each line is a self-contained JSON document. Parent directories are created automatically.

Trait Implementations§

Source§

impl Debug for ItemList

Source§

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

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

impl Default for ItemList

Source§

fn default() -> ItemList

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

impl Index<usize> for ItemList

Source§

type Output = Value

The returned type after indexing.
Source§

fn index(&self, idx: usize) -> &Self::Output

Performs the indexing (container[index]) operation. Read more
Source§

impl<'a> IntoIterator for &'a ItemList

Source§

type Item = &'a Value

The type of the elements being iterated over.
Source§

type IntoIter = Iter<'a, Value>

Which kind of iterator are we turning this into?
Source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more
Source§

impl IntoIterator for ItemList

Source§

type Item = Value

The type of the elements being iterated over.
Source§

type IntoIter = IntoIter<Value>

Which kind of iterator are we turning this into?
Source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. 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> 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> Same for T

Source§

type Output = T

Should always be Self
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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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