Struct debian_copyright::Copyright

pub struct Copyright(/* private fields */);

Implementations

impl Copyright

pub fn new() -> Self

pub fn empty() -> Self

pub fn header(&self) -> Option<Header>

pub fn iter_files(&self) -> impl Iterator<Item = FilesParagraph>

pub fn iter_licenses(&self) -> impl Iterator<Item = LicenseParagraph>

pub fn find_files(&self, filename: &Path) -> Option<FilesParagraph>

Returns the Files paragraph for the given filename.

Consistent with the specification, this returns the last paragraph that matches (which should be the most specific)

pub fn find_license_by_name(&self, name: &str) -> Option<License>

pub fn find_license_for_file(&self, filename: &Path) -> Option<License>

Returns the license for the given file.

Examples found in repository

examples/license-for-file.rs (line 26)

pub fn main() {
    let c = TEXT.parse::<Copyright>().unwrap();
    let license = c.find_license_for_file(Path::new("debian/foo")).unwrap();
    println!("{}", license.name().unwrap());
}

pub fn from_str_relaxed(s: &str) -> Result<(Self, Vec<String>), Error>

pub fn from_file_relaxed<P: AsRef<Path>>( path: P, ) -> Result<(Self, Vec<String>), Error>

pub fn from_file<P: AsRef<Path>>(path: P) -> Result<Self, Error>

Trait Implementations

impl Debug for Copyright

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

Formats the value using the given formatter.

impl Default for Copyright

fn default() -> Self

Returns the “default value” for a type.

impl Display for Copyright

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

Formats the value using the given formatter.

impl FromStr for Copyright

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.