Skip to main content

Package

Struct Package 

Source
pub struct Package {
Show 42 fields pub package_type: Option<PackageType>, pub namespace: Option<String>, pub name: Option<String>, pub version: Option<String>, pub qualifiers: Option<HashMap<String, String>>, pub subpath: Option<String>, pub primary_language: Option<String>, pub description: Option<String>, pub release_date: Option<String>, pub parties: Vec<Party>, pub keywords: Vec<String>, pub homepage_url: Option<String>, pub download_url: Option<String>, pub size: Option<u64>, pub sha1: Option<Sha1Digest>, pub md5: Option<Md5Digest>, pub sha256: Option<Sha256Digest>, pub sha512: Option<Sha512Digest>, pub bug_tracking_url: Option<String>, pub code_view_url: Option<String>, pub vcs_url: Option<String>, pub copyright: Option<String>, pub holder: Option<String>, pub declared_license_expression: Option<String>, pub declared_license_expression_spdx: Option<String>, pub license_detections: Vec<LicenseDetection>, pub other_license_expression: Option<String>, pub other_license_expression_spdx: Option<String>, pub other_license_detections: Vec<LicenseDetection>, pub extracted_license_statement: Option<String>, pub notice_text: Option<String>, pub source_packages: Vec<String>, pub is_private: bool, pub is_virtual: bool, pub extra_data: Option<HashMap<String, Value>>, pub repository_homepage_url: Option<String>, pub repository_download_url: Option<String>, pub api_data_url: Option<String>, pub purl: Option<String>, pub package_uid: PackageUid, pub datafile_paths: Vec<String>, pub datasource_ids: Vec<DatasourceId>,
}
Expand description

Top-level assembled package, created by merging one or more PackageData objects from related manifest/lockfiles (e.g., package.json + package-lock.json).

Compatible with ScanCode Toolkit output format. The key differences from PackageData are:

  • package_uid: unique identifier (PURL with UUID qualifier)
  • datafile_paths: list of all contributing files
  • datasource_ids: list of all contributing parsers
  • Excludes dependencies and file_references (hoisted to top-level)

Fields§

§package_type: Option<PackageType>§namespace: Option<String>§name: Option<String>§version: Option<String>§qualifiers: Option<HashMap<String, String>>§subpath: Option<String>§primary_language: Option<String>§description: Option<String>§release_date: Option<String>§parties: Vec<Party>§keywords: Vec<String>§homepage_url: Option<String>§download_url: Option<String>§size: Option<u64>§sha1: Option<Sha1Digest>§md5: Option<Md5Digest>§sha256: Option<Sha256Digest>§sha512: Option<Sha512Digest>§bug_tracking_url: Option<String>§code_view_url: Option<String>§vcs_url: Option<String>§copyright: Option<String>§holder: Option<String>§declared_license_expression: Option<String>§declared_license_expression_spdx: Option<String>§license_detections: Vec<LicenseDetection>§other_license_expression: Option<String>§other_license_expression_spdx: Option<String>§other_license_detections: Vec<LicenseDetection>§extracted_license_statement: Option<String>§notice_text: Option<String>§source_packages: Vec<String>§is_private: bool§is_virtual: bool§extra_data: Option<HashMap<String, Value>>§repository_homepage_url: Option<String>§repository_download_url: Option<String>§api_data_url: Option<String>§purl: Option<String>§package_uid: PackageUid

Unique identifier for this package instance (PURL with UUID qualifier).

§datafile_paths: Vec<String>

Paths to all datafiles that contributed to this package.

§datasource_ids: Vec<DatasourceId>

Datasource identifiers for all parsers that contributed to this package.

Implementations§

Source§

impl Package

Source

pub fn from_package_data( package_data: &PackageData, datafile_path: String, ) -> Self

Create a Package from a PackageData and its source file path.

Generates a unique package_uid from the package PURL when available. For packages without a PURL but with enough manifest identity to assemble, falls back to an opaque UID derived from datasource/name/version.

Source

pub fn update(&mut self, package_data: &PackageData, datafile_path: String)

Update this package with data from another PackageData.

Merges data from a related file (e.g., lockfile) into this package. Existing non-empty values are preserved; empty fields are filled from the new data. Lists (parties, license_detections) are merged.

Source

pub fn backfill_license_provenance(&mut self)

Trait Implementations§

Source§

impl Clone for Package

Source§

fn clone(&self) -> Package

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 Package

Source§

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

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

impl<'de> Deserialize<'de> for Package

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 From<&Package> for OutputPackage

Source§

fn from(value: &Package) -> Self

Converts to this type from the input type.
Source§

impl Serialize for Package

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

impl TryFrom<&OutputPackage> for Package

Source§

type Error = String

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

fn try_from(value: &OutputPackage) -> Result<Self, Self::Error>

Performs the conversion.

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> ArchivePointee for T

Source§

type ArchivedMetadata = ()

The archived version of the pointer metadata for this type.
Source§

fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata, ) -> <T as Pointee>::Metadata

Converts some archived metadata to the pointer metadata for itself.
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> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> LayoutRaw for T

Source§

fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>

Returns the layout of the type.
Source§

impl<T, N1, N2> Niching<NichedOption<T, N1>> for N2
where T: SharedNiching<N1, N2>, N1: Niching<T>, N2: Niching<T>,

Source§

unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool

Returns whether the given value has been niched. Read more
Source§

fn resolve_niched(out: Place<NichedOption<T, N1>>)

Writes data to out indicating that a T is niched.
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Pointee for T

Source§

type Metadata = ()

The metadata type for pointers and references to this type.
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> ToAst for T

Source§

fn ast(self, begin: usize, end: usize) -> Spanned<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<U, T> ToOwnedObj<U> for T
where U: FromObjRef<T>,

Source§

fn to_owned_obj(&self, data: FontData<'_>) -> U

Convert this type into T, using the provided data to resolve any offsets.
Source§

impl<U, T> ToOwnedTable<U> for T
where U: FromTableRef<T>,

Source§

fn to_owned_table(&self) -> U

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