Skip to main content

ReadmeParser

provenant::parsers

Struct ReadmeParser

pub struct ReadmeParser;

Expand description

README attribution file parser.

Extracts package metadata from semi-structured README files commonly used to document third-party dependencies in large codebases.

Trait Implementations§

impl PackageParser for ReadmeParser

const PACKAGE_TYPE: PackageType = PackageType::Readme

Package URL type identifier for this parser (e.g., PackageType::Npm, PackageType::Pypi).

fn is_match(path: &Path) -> bool

Checks if the given file path matches this parser’s expected format. Read more

fn extract_packages(path: &Path) -> Vec<PackageData>

Extracts all packages from the given file path. Read more

fn extract_first_package(path: &Path) -> PackageData

Returns the first package from extract_packages(), or a default PackageData if the file contains no packages.

Auto Trait Implementations§

impl Freeze for ReadmeParser

impl RefUnwindSafe for ReadmeParser

impl Send for ReadmeParser

impl Sync for ReadmeParser

impl Unpin for ReadmeParser

impl UnsafeUnpin for ReadmeParser

impl UnwindSafe for ReadmeParser

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> ArchivePointee for T

type ArchivedMetadata = ()

The archived version of the pointer metadata for this type.

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

Converts some archived metadata to the pointer metadata for itself.

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T
where U: From<T>,

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

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

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

impl<T> LayoutRaw for T

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

Returns the layout of the type.

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

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

Returns whether the given value has been niched. Read more

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

Writes data to out indicating that a T is niched.

impl<T> Pointable for T

const ALIGN: usize

The alignment of pointer.

type Init = T

The type for initializers.

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

Initializes a with the given initializer. Read more

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

Dereferences the given pointer. Read more

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

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

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

impl<T> Pointee for T

type Metadata = ()

The metadata type for pointers and references to this type.

impl<T> Same for T

type Output = T

Should always be Self

impl<T> ToAst for T

fn ast(self, begin: usize, end: usize) -> Spanned<Self>

impl<U, T> ToOwnedObj<U> for T
where U: FromObjRef<T>,

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

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

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

fn to_owned_table(&self) -> U

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.