Skip to main content

LicenseSource

Enum LicenseSource 

Source
#[non_exhaustive]
pub enum LicenseSource { RegistryDeclaredSpdx, FetchedDeclaredSpdx, DetectedSpdx, PomFreeText, }
Expand description

How this ecosystem’s license strings are sourced.

Drives three ecosystem-specific license behaviors that used to be re-derived independently at each consumer via a non-exhaustive matches!/== on EcosystemId instead of the sealed Ecosystem trait every other per-ecosystem capability goes through (issue #688): hover’s “(detected)” qualifier, which only applies to Self::DetectedSpdx; whether crate::licenses::resolve_license_entries must normalize free text to SPDX identifiers before hover displays it or a crate::licenses::LicensePolicy evaluates it, which only applies to Self::PomFreeText; and, via Self::requires_dedicated_fetch (issue #697), whether Ecosystem::fetch_license is a dedicated async fetch or a no-op because the license already arrived in the hot-path registry response.

§Examples

use deps_core::LicenseSource;

assert_eq!(LicenseSource::default(), LicenseSource::RegistryDeclaredSpdx);
assert_ne!(LicenseSource::PomFreeText, LicenseSource::DetectedSpdx);

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

RegistryDeclaredSpdx

Author-declared SPDX identifier(s) already present in the hot-path registry response — the default for every ecosystem that doesn’t override Ecosystem::license_source, and the only variant for which Self::requires_dedicated_fetch is false.

§

FetchedDeclaredSpdx

Author-declared SPDX identifier(s) that require a dedicated fetch separate from the hot-path registry response: JSR’s package-metadata endpoint (Deno).

§

DetectedSpdx

A detector’s best-effort guess, not an author declaration, that requires a dedicated fetch: pub.dev’s /score endpoint (Dart) and GitHub’s license.spdx_id (Swift) are both driven by a license-detection heuristic run against repository content, rather than metadata the package author explicitly declared to a registry.

§

PomFreeText

Maven POM <licenses><license><name> free text (Gradle), fetched via a dedicated request — never an SPDX identifier, so it must be normalized via crate::licenses::resolve_license_entries before display or policy evaluation.

Implementations§

Source§

impl LicenseSource

Source

pub const fn requires_dedicated_fetch(self) -> bool

Whether this source requires Ecosystem::fetch_license’s dedicated async fetch, as opposed to arriving for free in the hot-path registry response.

This is the single answer to “is this a tier-3 license ecosystem” (issue #697): capability and shape can no longer disagree, because both come from the same Ecosystem::license_source call.

§Examples
use deps_core::LicenseSource;

assert!(!LicenseSource::RegistryDeclaredSpdx.requires_dedicated_fetch());
assert!(LicenseSource::FetchedDeclaredSpdx.requires_dedicated_fetch());
assert!(LicenseSource::DetectedSpdx.requires_dedicated_fetch());
assert!(LicenseSource::PomFreeText.requires_dedicated_fetch());

Trait Implementations§

Source§

impl Clone for LicenseSource

Source§

fn clone(&self) -> Self

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 Copy for LicenseSource

Source§

impl Debug for LicenseSource

Source§

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

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

impl Default for LicenseSource

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Eq for LicenseSource

Source§

impl PartialEq for LicenseSource

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for LicenseSource

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> 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<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
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: 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
Source§

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> 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 = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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