Expand description
Lossless, failure-tolerant operations on R DESCRIPTION files.
RDescription::parse always returns a recovered document, even when its
DCF structure is malformed. Structural issues remain available through
RDescription::syntax_issues, while typed fields are validated only when
their accessors are called. A malformed field therefore does not prevent
access to valid unrelated fields.
Unmodified syntax is retained byte-for-byte. Named setters validate and canonically format the field they replace while preserving unrelated syntax.
use r_description::{RDescription, Relation};
let source = "Package example\n\
Version: 1.2-0\n\
Imports: cli (>= 3.0), glue\n\
URL: not-a-url\n";
let description = RDescription::parse(source);
assert!(!description.syntax_issues().is_empty());
assert_eq!(description.version()?.as_str(), "1.2-0");
let imports: Vec<Relation> = description.imports()?.collect();
assert_eq!(imports.len(), 2);
assert!(description.urls().is_err());
assert_eq!(description.to_string(), source);Structural issues, Spanned values, and positioned collection errors use
absolute ranges into the current document rendering. Standalone parsers and
nested errors such as VersionParseError may use ranges relative to their
typed input, as documented by those types. Reacquire document-relative
issues and spanned values after mutation.
Structs§
- Bioconductor
Credentials - Credentials embedded in a Bioconductor source declaration.
- Bioconductor
Remote - A Bioconductor Git source declaration.
- Cran
Remote - A CRAN source declaration.
- Generic
GitRemote - A generic Git source declaration.
- Hosted
GitRemote - A hosted Git repository declaration.
- Invalid
Relation Package - Error constructing a relation with an ambiguous package name.
- Local
Remote - A local source declaration.
- Positioned
Parse Error - A positioned parse error containing location information.
- Positioned
Relation Parse Error - A relation parse error paired with its byte range.
- Positioned
Remote Parse Error - A remote parse error paired with its half-open UTF-8 byte range.
- Positioned
UrlParse Error - A URL parse error paired with its byte range.
- RDescription
- A losslessly parsed R
DESCRIPTIONdocument. - Relation
- A package dependency and its version requirement.
- Remote
- One source declaration from a
Remotesfield. - Spanned
- A logical value paired with its absolute range in a
DESCRIPTIONdocument. - SvnRemote
- A Subversion source declaration.
- Text
Range - A range in text, represented as a pair of
TextSize. - Unknown
Remote - An unknown explicit source declaration.
- Url
- A parsed URL record.
- UrlMutation
Error - Error writing a typed URL collection field.
- UrlRemote
- A URL source declaration.
- Version
- A valid R package version with its original spelling preserved.
Enums§
- Additional
Repositories Error - Errors returned while parsing the
Additional_repositoriesfield. - Author
Error - Errors returned by
RDescription::author. - Authors
AtRError - Errors returned by
RDescription::authors_at_r. - Biarch
Error - Errors returned by
RDescription::biarch. - BugReports
Error - Errors returned by
RDescription::bug_reports. - Build
Vignettes Error - Errors returned by
RDescription::build_vignettes. - Byte
Compile Error - Errors returned by
RDescription::byte_compile. - Contact
Error - Errors returned by
RDescription::contact. - Copyright
Error - Errors returned by
RDescription::copyright. - Date
Error - Errors returned by
RDescription::date. - Depends
Error - Errors returned by
RDescription::depends. - Description
Error - Errors returned by
RDescription::description. - Encoding
Error - Errors returned by
RDescription::encoding. - Enhances
Error - Errors returned by
RDescription::enhances. - Field
Mutation Error - Error validating caller-provided field mutation input.
- Imports
Error - Errors returned by
RDescription::imports. - Keep
Source Error - Errors returned by
RDescription::keep_source. - Lazy
Data Error - Errors returned by
RDescription::lazy_data. - Lazy
Load Error - Errors returned by
RDescription::lazy_load. - License
Error - Errors returned by
RDescription::license. - License
IsFoss Error - Errors returned by
RDescription::license_is_foss. - License
Restricts UseError - Errors returned by
RDescription::license_restricts_use. - Linking
ToError - Errors returned by
RDescription::linking_to. - Mailing
List Error - Errors returned by
RDescription::mailing_list. - Maintainer
Error - Errors returned by
RDescription::maintainer. - Needs
Compilation Error - Errors returned by
RDescription::needs_compilation. - Note
Error - Errors returned by
RDescription::note. - OsType
Error - Errors returned by
RDescription::os_type. - Package
Error - Errors returned by
RDescription::package. - Package
Type Error - Errors returned by
RDescription::package_type. - Priority
Error - Errors returned by
RDescription::priority. - Relation
Parse Error - A typed parse error found in a package relation.
- Remote
Mutation Error - Error writing a
Remotesfield from caller-provided semantic values. - Remote
Parse Error - A typed parse error found in one remote specification.
- Remote
Source - A source supported by the
Remotessyntax. - Remotes
Error - Errors returned by
RDescription::remotes. - Repository
Error - Errors returned by
RDescription::repository. - Staged
Install Error - Errors returned by
RDescription::staged_install. - Suggests
Error - Errors returned by
RDescription::suggests. - System
Requirements Error - Errors returned by
RDescription::system_requirements. - Title
Error - Errors returned by
RDescription::title. - UrlError
- Errors returned while parsing the
URLfield. - UrlParse
Error - A typed parse error found in a URL collection field.
- UseLto
Error - Errors returned by
RDescription::use_lto. - Version
Error - Errors returned by
RDescription::version. - Version
Parse Error - Error parsing an R package version.
- Version
Requirement - One of the seven semantic version-requirement states supported by R.
- ZipData
Error - Errors returned by
RDescription::zip_data.