Skip to main content

UserExtensionConfig

Struct UserExtensionConfig 

Source
#[non_exhaustive]
pub struct UserExtensionConfig { pub additional_hosts: Vec<UserExtensionHost>, pub trust_academic_repos: bool, pub trust_oa_registries: bool, pub store_root: Option<String>, pub contact_email: Option<String>, pub unpaywall_email: Option<String>, pub cite_key_template: Option<String>, pub cite_file_field: Option<String>, }
Expand description

Parsed result from a config.toml user-extension section (issue #323).

Returned by load; callers merge Self::additional_hosts into the allowlist unconditionally, and optionally merge academic_repo_hosts when Self::trust_academic_repos is true.

Fields (Non-exhaustive)§

This struct is marked as 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.
§additional_hosts: Vec<UserExtensionHost>

Hosts from [[network.additional_hosts]].

§trust_academic_repos: bool

true when [network] trust_academic_repos = true is set in config.toml. Callers that respect this flag SHOULD merge academic_repo_hosts into their allowlist.

§trust_oa_registries: bool

true when [network] trust_oa_registries = true is set in config.toml. Callers that respect this flag SHOULD merge oa_registry_hosts into their allowlist.

§store_root: Option<String>

[store] root, verbatim, when present and non-empty (#441).

Returned as the raw string rather than a path: expanding it needs a home directory, and this crate has no home-directory dependency. The CLI and MCP resolvers own that step, and both place this rung below DOIGET_STORE_ROOT and above the cwd default (ADR-0036).

§contact_email: Option<String>

[network] contact_email, trimmed, when present and non-empty (#504). Rung below DOIGET_CONTACT_EMAIL.

§unpaywall_email: Option<String>

[network] unpaywall_email, trimmed, when present and non-empty (#504). Rung below DOIGET_UNPAYWALL_EMAIL, itself above Self::contact_email.

§cite_key_template: Option<String>

[cite] key_template – the default --key-template (#610). Blank is absent.

§cite_file_field: Option<String>

[cite] file_field – the default --file-field pattern (#610).

Trait Implementations§

Source§

impl Debug for UserExtensionConfig

Source§

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

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

impl Default for UserExtensionConfig

Source§

fn default() -> UserExtensionConfig

Returns the “default value” for a type. 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.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

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.

§

impl<T> PolicyExt for T
where T: ?Sized,

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + 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
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + 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, 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.
§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more