Skip to main content

r_metadata/
lib.rs

1//! Semantic values used in R package metadata.
2//!
3//! Collection parsers in this crate recover at delimiters: malformed entries
4//! are reported as positioned issues without discarding valid neighbours.
5
6#![forbid(unsafe_code)]
7
8mod relation;
9mod remote;
10mod scalar;
11mod urls;
12mod version;
13
14pub use relation::{
15    InvalidRelationPackage, PositionedRelationParseError, Relation, RelationList,
16    RelationParseError, RequirementVersion, RequirementVersionParseError, Revision,
17    RevisionParseError, VersionRequirement,
18};
19pub use remote::{
20    BioconductorCredentials, BioconductorRemote, CranRemote, GenericGitRemote, HostedGitRemote,
21    LocalRemote, PositionedRemoteParseError, Remote, RemoteList, RemoteParseError, RemoteSource,
22    SvnRemote, UnknownRemote, UrlRemote,
23};
24pub use scalar::{
25    Logical, LogicalParseError, OsType, OsTypeParseError, Priority, PriorityParseError,
26};
27pub use url::Url;
28pub use urls::{
29    AdditionalRepositories, PositionedUrlParseError, SpannedUrl, UrlList, UrlParseError,
30};
31pub use version::{Version, VersionParseError};
32
33/// A half-open UTF-8 byte span into parser input.
34#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, PartialOrd, Ord)]
35pub struct Span {
36    start: usize,
37    end: usize,
38}
39
40impl Span {
41    /// Creates a span. `start` and `end` are byte offsets.
42    pub const fn new(start: usize, end: usize) -> Self {
43        Self { start, end }
44    }
45
46    /// Returns the inclusive start byte offset.
47    pub const fn start(self) -> usize {
48        self.start
49    }
50
51    /// Returns the exclusive end byte offset.
52    pub const fn end(self) -> usize {
53        self.end
54    }
55
56    /// Returns whether this span has zero length.
57    pub const fn is_empty(self) -> bool {
58        self.start == self.end
59    }
60
61    /// Returns the span length in bytes.
62    pub const fn len(self) -> usize {
63        self.end - self.start
64    }
65}
66
67/// A semantic value and its half-open byte span in the parsed collection.
68#[derive(Debug, Clone, PartialEq, Eq, Hash)]
69pub struct Spanned<T> {
70    /// Parsed value.
71    pub value: T,
72    /// Span covering the complete trimmed entry.
73    pub span: Span,
74}
75
76impl<T> Spanned<T> {
77    /// Returns the parsed value.
78    pub const fn value(&self) -> &T {
79        &self.value
80    }
81
82    /// Returns the value's source span.
83    pub const fn span(&self) -> Span {
84        self.span
85    }
86}