Struct RDescription 

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

R DESCRIPTION file

Implementations

impl RDescription

pub fn new() -> Self

Create a new empty R DESCRIPTION file

pub fn package(&self) -> Option<String>

Return the package name

pub fn set_package(&mut self, package: &str)

Set the package name

pub fn title(&self) -> Option<String>

One line description of the package, and is often shown in a package listing

It should be plain text (no markup), capitalised like a title, and NOT end in a period. Keep it short: listings will often truncate the title to 65 characters.

pub fn maintainer(&self) -> Option<String>

Return the maintainer of the package

pub fn set_maintainer(&mut self, maintainer: &str)

Set the maintainer of the package

pub fn authors(&self) -> Option<RCode>

Return the authors of the package

pub fn set_authors(&mut self, authors: &RCode)

Set the authors of the package

pub fn set_title(&mut self, title: &str)

Set the title of the package

pub fn description(&self) -> Option<String>

Return the description of the package

pub fn set_description(&mut self, description: &str)

Set the description of the package

pub fn version(&self) -> Option<String>

Return the version of the package

pub fn set_version(&mut self, version: &str)

Set the version of the package

pub fn encoding(&self) -> Option<String>

Return the encoding of the description file

pub fn set_encoding(&mut self, encoding: &str)

Set the encoding of the description file

pub fn license(&self) -> Option<String>

Return the license of the package

pub fn set_license(&mut self, license: &str)

Set the license of the package

pub fn roxygen_note(&self) -> Option<String>

Return the roxygen note

pub fn set_roxygen_note(&mut self, roxygen_note: &str)

Set the roxygen note

pub fn roxygen(&self) -> Option<String>

Return the roxygen version

pub fn set_roxygen(&mut self, roxygen: &str)

Set the roxygen version

pub fn url(&self) -> Option<String>

Return the URL field

pub fn set_url(&mut self, url: &str)

Set the URL field

pub fn bug_reports(&self) -> Option<Url>

Return the bug reports URL

pub fn set_bug_reports(&mut self, bug_reports: &Url)

Set the bug reports URL

pub fn imports(&self) -> Option<Vec<String>>

Return the imports field

pub fn set_imports(&mut self, imports: &[&str])

Set the imports field

pub fn suggests(&self) -> Option<Relations>

Return the suggests field

pub fn set_suggests(&mut self, suggests: Relations)

Set the suggests field

pub fn depends(&self) -> Option<Relations>

Return the depends field

pub fn set_depends(&mut self, depends: Relations)

Set the depends field

pub fn linking_to(&self) -> Option<Vec<String>>

Return the linking-to field

pub fn set_linking_to(&mut self, linking_to: &[&str])

Set the linking-to field

pub fn lazy_data(&self) -> Option<bool>

Return the lazy data field

pub fn set_lazy_data(&mut self, lazy_data: bool)

Set the lazy data field

pub fn collate(&self) -> Option<String>

Return the collate field

pub fn set_collate(&mut self, collate: &str)

Set the collate field

pub fn vignette_builder(&self) -> Option<Vec<String>>

Return the vignette builder field

pub fn set_vignette_builder(&mut self, vignette_builder: &[&str])

Set the vignette builder field

pub fn system_requirements(&self) -> Option<Vec<String>>

Return the system requirements field

pub fn set_system_requirements(&mut self, system_requirements: &[&str])

Set the system requirements field

pub fn date(&self) -> Option<String>

Return the date field

pub fn set_date(&mut self, date: &str)

Set the date field

pub fn repository(&self) -> Option<String>

The R Repository to use for this package.

E.g. “CRAN” or “Bioconductor”

pub fn set_repository(&mut self, repository: &str)

Set the R Repository to use for this package.

Trait Implementations

impl Default for RDescription

fn default() -> Self

Returns the “default value” for a type.

impl Display for RDescription

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

Formats the value using the given formatter.

impl FromStr for RDescription

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.