file_header::license::spdx

Struct SpdxLicense

pub struct SpdxLicense<L: LicenseTokens> { /* private fields */ }

Expand description

Metadata around an SPDX license to enable constructing a Header.

<L> is the LicenseTokens that defines what, if any, replacement tokens are needed.

Implementations§

impl<L: LicenseTokens> SpdxLicense<L>

pub fn new( license_text: Box<dyn License + Sync + Send>, search_pattern: String, lines_to_search: usize, ) -> Self

spdx_license: the SPDX license search_pattern: the text to search for when checking for the presence of the license lines_to_search: how many lines to search for search_pattern before giving up

pub fn build_header( &self, replacement_values: L::TokenReplacementValues, ) -> Header<SingleLineChecker>

Build a header for this license using the provided year and copyright_holder to interpolate into the license. The license’s header is used, if the license offers one, otherwise the main license text is used instead.

Auto Trait Implementations§

impl<L> Freeze for SpdxLicense<L>

impl<L> !RefUnwindSafe for SpdxLicense<L>

impl<L> Send for SpdxLicense<L>
where L: Send,

impl<L> Sync for SpdxLicense<L>
where L: Sync,

impl<L> Unpin for SpdxLicense<L>
where L: Unpin,

impl<L> !UnwindSafe for SpdxLicense<L>

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