Struct Engine 

#[non_exhaustive]
pub struct Engine {
    pub signals: Vec<Signal>,
    pub request_headers: BTreeMap<String, String>,
    pub regex_check: Option<String>,
}

Shared detection signature template for a family of sites that run the same forum / blog / wiki software (Discourse, vBulletin, XenForo, MediaWiki, …). Referenced from Site::engine.

Engines carry the same kinds of fields as a Site does (just the inheritable ones — there’s no per-engine url, that comes from the site itself). At registry load, the engine’s fields are merged under each referring site’s own fields: site wins on conflict.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

signals: Vec<Signal>

Default detection signals for sites of this family. Inherited only when the site itself declares no signals.

request_headers: BTreeMap<String, String>

Default extra HTTP headers (e.g. a User-Agent that the platform accepts where the browser default gets blocked). Merged with the site’s own headers; site wins per-key.

regex_check: Option<String>

Default username-validity regex inherited only when the site itself doesn’t declare one.

Implementations

impl Engine

pub fn validate(&self, name: &str) -> Result<()>

Compile-check the engine’s own constraints — the inheritable fields are subject to the same validation as a site’s would be.

Errors

Returns Error::InvalidSite when the engine name is empty, a signal carries an empty marker, or any other constraint a Site::validate would also flag.

pub fn merge_into(&self, site: &mut Site)

Fill the inheritable empty / unset fields of site from this engine. Site fields are authoritative: if the site has any signals at all, no engine signals are merged in. request_headers merge per-key (site wins on per-key conflict).

Trait Implementations

impl Clone for Engine

fn clone(&self) -> Engine

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Engine

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

Formats the value using the given formatter.

impl Default for Engine

fn default() -> Engine

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Engine

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Engine

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.