Enum Format 

pub enum Format {
    SlashSlash,
    Hash,
}

Variants

SlashSlash

The // ... format

Hash

The # ... format

Implementations

impl Format

pub fn from_path(path: &Path) -> Self

pub fn check_strip_license_line(self, line: &str) -> Option<&str>

Strip the license line if it’s the right format. Return the SPDX id

pub fn check_strip_copyright_line(self, line: &str) -> Option<&str>

Strip the copyright line if it’s the right format. Return “YYYY[-YYYY] HOLDER”

pub fn starts_with_sentinel(self, line: &str) -> bool

Check if the line starts with sentinel comment

pub fn format( self, year_start: u32, holder: &str, license: &str, buf: &mut String, ) -> Result<()>

Format the license notice into a buffer

Trait Implementations

impl Clone for Format

fn clone(&self) -> Format

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Format

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

Formats the value using the given formatter.

impl PartialEq for Format

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for Format

impl Eq for Format

impl StructuralPartialEq for Format