Namespace Snowflake.Scraping.Extensibility

Classes

DirectiveAttribute

Specifies a directive on a IScraper that determines when and what information it must have access to before it is run.

SeedBuilder

Provides helper methods for building SeedTree for use in IScraper implementations.

Enables use of underscore methods for "SeedBuilder syntax". Import this class with a

using static

directive.

_(SeedTree[]) to continue for nested seeds.

Remember that top-level seeds can be System.Threading.Tasks.Task<TResult> and other awaitables.

Traverser<TProducts, TEffectTarget>

Structs

Used when building a seed tree, represents a SeedContent with context-free parent/child relationships. This should never be used directly outside of the return value of an IScraper. There is no way to instantiate this class besides implicitly converting from an instance of SeedContent. SeedTree does not implement System.IEquatable<T>, and thus is not equatable.

Interfaces

ICuller

A ICuller filters seeds that remain in consideration when the ISeedRootContext is traversed to produce a result.

IFileInstallationTraverser

A FileInstallationTraverser is a specialized traverser that installs additional files to a game, such as images and videos, yielding them much in the same way as IGameInstaller.

IGameMetadataTraverser

A GameMetadataTraverser is a specialized traverser that yields metadata for a game given a seed root context.

IScraper

A IScraper specifies a type of ISeed and some restrictions on the seed, and uses the value of the seed to return a resultant tree of new seeds.

IScraperDirective

Specifies a directive on a IScraper that determines when and what information it must have access to before it is run.

ITraverser<TProducts, TEffectTarget>

A traverser traverses the resultant ISeedRootContext, or rather sub-trees relative to a given seed in the context, and applies side effects according to the final seed tree, producing a list of TProducts given the information available in the seed tree.

Enums

AttachTarget

Specifies the seed to which the results are attached or applied to. In the case of DirectiveAttribute, specifies the seed with which the directive applies to.

Directive

Specifies the requirements of a directive evaluated when deciding if a IScraper is run or not.