Skip to main content

FileInfo

provenant::models

Struct FileInfo 

Source 
pub struct FileInfo {
Show 47 fields
    pub name: String,
    pub base_name: String,
    pub extension: String,
    pub path: String,
    pub file_type: FileType,
    pub mime_type: Option<String>,
    pub file_type_label: Option<String>,
    pub size: u64,
    pub date: Option<String>,
    pub sha1: Option<Sha1Digest>,
    pub md5: Option<Md5Digest>,
    pub sha256: Option<Sha256Digest>,
    pub sha1_git: Option<GitSha1>,
    pub programming_language: Option<String>,
    pub package_data: Vec<PackageData>,
    pub license_expression: Option<String>,
    pub license_detections: Vec<LicenseDetection>,
    pub license_clues: Vec<Match>,
    pub percentage_of_license_text: Option<f64>,
    pub copyrights: Vec<Copyright>,
    pub holders: Vec<Holder>,
    pub authors: Vec<Author>,
    pub emails: Vec<OutputEmail>,
    pub urls: Vec<OutputURL>,
    pub for_packages: Vec<PackageUid>,
    pub scan_errors: Vec<String>,
    pub scan_diagnostics: Vec<ScanDiagnostic>,
    pub license_policy: Option<Vec<LicensePolicyEntry>>,
    pub is_generated: Option<bool>,
    pub is_binary: Option<bool>,
    pub is_text: Option<bool>,
    pub is_archive: Option<bool>,
    pub is_media: Option<bool>,
    pub is_source: Option<bool>,
    pub is_script: Option<bool>,
    pub files_count: Option<usize>,
    pub dirs_count: Option<usize>,
    pub size_count: Option<u64>,
    pub source_count: Option<usize>,
    pub is_legal: bool,
    pub is_manifest: bool,
    pub is_readme: bool,
    pub is_top_level: bool,
    pub is_key_file: bool,
    pub is_community: bool,
    pub facets: Vec<String>,
    pub tallies: Option<Tallies>,

}
Expand description

File-level scan result containing metadata and detected findings.

Fields§

§name: String§base_name: String§extension: String§path: String§file_type: FileType§mime_type: Option<String>§file_type_label: Option<String>§size: u64§date: Option<String>§sha1: Option<Sha1Digest>§md5: Option<Md5Digest>§sha256: Option<Sha256Digest>§sha1_git: Option<GitSha1>§programming_language: Option<String>§package_data: Vec<PackageData>§license_expression: Option<String>§license_detections: Vec<LicenseDetection>§license_clues: Vec<Match>§percentage_of_license_text: Option<f64>§copyrights: Vec<Copyright>§holders: Vec<Holder>§authors: Vec<Author>§emails: Vec<OutputEmail>§urls: Vec<OutputURL>§for_packages: Vec<PackageUid>§scan_errors: Vec<String>§scan_diagnostics: Vec<ScanDiagnostic>§license_policy: Option<Vec<LicensePolicyEntry>>§is_generated: Option<bool>§is_binary: Option<bool>§is_text: Option<bool>§is_archive: Option<bool>§is_media: Option<bool>§is_source: Option<bool>§is_script: Option<bool>§files_count: Option<usize>§dirs_count: Option<usize>§size_count: Option<u64>§source_count: Option<usize>§is_legal: bool§is_manifest: bool§is_readme: bool§is_top_level: bool§is_key_file: bool§is_community: bool§facets: Vec<String>§tallies: Option<Tallies>

Implementations§

Source§

impl FileInfo

Source

pub fn new( name: String, base_name: String, extension: String, path: String, file_type: FileType, mime_type: Option<String>, file_type_label: Option<String>, size: u64, date: Option<String>, sha1: Option<Sha1Digest>, md5: Option<Md5Digest>, sha256: Option<Sha256Digest>, programming_language: Option<String>, package_data: Vec<PackageData>, license_expression: Option<String>, license_detections: Vec<LicenseDetection>, license_clues: Vec<Match>, copyrights: Vec<Copyright>, holders: Vec<Holder>, authors: Vec<Author>, emails: Vec<OutputEmail>, urls: Vec<OutputURL>, for_packages: Vec<PackageUid>, scan_errors: Vec<String>, ) -> Self

Construct a FileInfo from fully resolved scanner fields.

Source

pub fn backfill_license_provenance(&mut self)

Source§

impl FileInfo

Source

pub fn warning_diagnostics(&self) -> impl Iterator<Item = &ScanDiagnostic>

Source

pub fn error_diagnostics(&self) -> impl Iterator<Item = &ScanDiagnostic>

Trait Implementations§

Source§

impl Clone for FileInfo

Source§

fn clone(&self) -> FileInfo

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for FileInfo

Source§

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

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

impl<'de> Deserialize<'de> for FileInfo

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<&FileInfo> for OutputFileInfo

Source§

fn from(value: &FileInfo) -> Self

Converts to this type from the input type.
Source§

impl Serialize for FileInfo

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<&OutputFileInfo> for FileInfo

Source§

type Error = String

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

fn try_from(value: &OutputFileInfo) -> 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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> 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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,