Skip to main content

Site

Struct Site 

Source
pub struct Site {
    pub name: String,
    pub url: UrlTemplate,
    pub signals: Vec<Signal>,
    pub known_present: Option<KnownPresent>,
    pub known_absent: Option<String>,
    pub extract: Vec<Extractor>,
    pub tags: Vec<String>,
    pub request_headers: BTreeMap<String, String>,
    pub regex_check: Option<String>,
    pub engine: Option<String>,
}
Expand description

One site we can probe for the existence of an account.

Fields§

§name: String

Human-readable site name. Doubles as the stable filter key (case-insensitive) used by CLI --only / --exclude.

§url: UrlTemplate

URL template containing a {username} placeholder.

§signals: Vec<Signal>

Ordered list of detection signals. Aggregated per the type-level docs. Optional in source JSON when Site::engine is set — the engine’s signals are inherited at load time. After crate::Registry resolution this vec is always non-empty (or the site fails validate).

§known_present: Option<KnownPresent>

One or more usernames known to exist on this site. Consumed by adler doctor to verify the signal list still reports Found for a real account. Accepts either a single string or an array of strings in JSON; the doctor probes each in declaration order and passes the present-check if any one of them resolves to Found. Listing several is defensive — brand accounts or other users that the site special-cases (e.g. Instagram’s own instagram account) shouldn’t false-fail the whole site.

§known_absent: Option<String>

Username known to not exist on this site (optional). When omitted, the doctor generates a random nonsense username instead.

§extract: Vec<Extractor>

Optional CSS-selector rules for pulling profile fields (name, bio, avatar, …) out of a Found page. Only applied under --enrich.

§tags: Vec<String>

Free-form classification tags for scanning a subset of the registry, e.g. "social", "dev", "region:ru". Matched by CLI --tag. A site with no tags is universal (included unless a --tag filter excludes it). Conventionally lowercase; axis:value is just a naming convention, not enforced.

§request_headers: BTreeMap<String, String>

Extra HTTP headers to send with the probe (e.g. {"X-IG-App-ID": "936619743392459"} to unlock Instagram’s web_profile_info endpoint, or a custom User-Agent). Browser backends apply them via Network.setExtraHTTPHeaders before navigation; the raw-HTTP path doesn’t read this yet.

§regex_check: Option<String>

Optional regular expression describing usernames a site will accept. When set and the scanned username doesn’t match, the site is skipped (the outcome is reported as Uncertain with reason UsernameNotAllowed, without issuing any HTTP request). Saves work AND avoids the false-positive class where a site 404s on illegal usernames in ways our signal can’t tell apart from a missing account.

Imported from Sherlock’s regexCheck field; 95+ sites upstream carry one (length bounds, character classes, etc.). Validation at load time compiles the regex with regex::Regex — a malformed pattern rejects the site rather than silently degrading at scan time.

§engine: Option<String>

Name of a shared Engine this site inherits from (e.g. "Discourse", "vBulletin"). Forum-software platforms host thousands of instances with identical detection signatures; defining the signature once on an engine and inheriting it keeps the registry small and the cost of a platform-wide HTML change one fix instead of hundreds.

At crate::Registry::validate time, engine fields are merged under the site’s own — anything the site declares explicitly (signals, request_headers, regex_check) wins on conflict; anything left empty / unset is filled from the engine. An engine: "X" referring to a non-existent X is a load-time error.

Implementations§

Source§

impl Site

Source

pub fn url_for(&self, username: &Username) -> String

Render the site URL for a given username.

Source

pub fn validate(&self) -> Result<()>

Validate semantic invariants the type system can’t enforce (empty signals list, empty markers, empty status code sets).

Trait Implementations§

Source§

impl Clone for Site

Source§

fn clone(&self) -> Site

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 Site

Source§

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

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

impl<'de> Deserialize<'de> for Site

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for Site

Source§

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 Site

§

impl RefUnwindSafe for Site

§

impl Send for Site

§

impl Sync for Site

§

impl Unpin for Site

§

impl UnsafeUnpin for Site

§

impl UnwindSafe for Site

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> 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> PolicyExt for T
where T: ?Sized,

Source§

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
Source§

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
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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 = 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
Source§

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