Struct spyglass_lens::LensConfig

pub struct LensConfig {

    pub author: String,
    pub name: String,
    pub label: String,
    pub description: Option<String>,
    pub domains: Vec<String>,
    pub urls: Vec<String>,
    pub version: String,
    pub rules: Vec<LensRule>,
    pub trigger: String,
    pub pipeline: Option<String>,
    pub lens_source: LensSource,
    pub categories: Vec<String>,
    pub tags: Vec<(String, String)>,
    pub file_path: PathBuf,
    pub hash: String,
    pub is_enabled: bool,
}

Contexts are a set of domains/URLs/etc. that restricts a search space to improve results.

Fields

author: String

name: String

Unique identifier for the lens

label: String

Human readable title for the lens

description: Option<String>

Optional description of the lens and what it contains.

domains: Vec<String>

Whole domains we want to be part of the index.

urls: Vec<String>

Specific URLs or URL prefixes that will be crawled

version: String

Semantic version of this lens (will be used to check for updates in the future).

rules: Vec<LensRule>

Rules to skip/constrain what URLs are indexed

trigger: String

pipeline: Option<String>

lens_source: LensSource

categories: Vec<String>

Category(ies) this lens is in.

tags: Vec<(String, String)>

Tags to automatically apply to any URLs indexed by this lens

file_path: PathBuf

hash: String

is_enabled: bool

Implementations

impl LensConfig

pub fn label(&self) -> String

pub fn into_regexes(&self) -> LensFilters

pub fn from_string(contents: &str) -> Result<Self>

pub fn from_path(path: PathBuf) -> Result<Self>

pub fn all_tags(&self) -> Vec<(String, String)>

Trait Implementations

impl Clone for LensConfig

fn clone(&self) -> LensConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for LensConfig

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

Formats the value using the given formatter.

impl Default for LensConfig

fn default() -> LensConfig

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for LensConfig

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

Deserialize this value from the given Serde deserializer.

impl Serialize for LensConfig

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

Serialize this value into the given Serde serializer.