Struct DataCitation 

pub struct DataCitation {
    pub set: GovernanceLogId,
    pub commit: Option<GitCommitPrefix>,
    pub path: DataFilePath,
    pub lines: Option<LineRange>,
}

A data set’s file, cited at the commit it was read at, and optionally lines of it: DATA-2026-0001:<commit>:<path>:110-300, or without the range for the whole file (0.103). The commit may be left out, the path then written from the root with a leading /: DATA-2026-0001:/<path> or DATA-2026-0001:/<path>:110-300, for the commit the set pins as it stands (0.110.0).

get_content takes one as its id and reads that file (and those lines). The commit is a prefix of at least seven hex digits of the commit the data set pins. A server reads the set as revised (its latest version) when the commit is the latest version’s, and as originally signed when it is the original’s, so a citation made before any revision keeps reading what it cited. One made at an intermediate revision’s commit stops resolving once a later revision pins another commit. One without a commit reads the latest version, as the set’s own id does: it is unambiguous today (a set pins exactly one commit) but follows any revision, so the canonical citation, which a record should keep, names the commit; the file read says which it was.

After the set’s id and its :, a citation is one of two forms (Steward, 2026-10-20): <commit>:<path>, the commit 7 to 40 hex digits, or /<path>, a path from the repository root with no commit. Anything else is refused, naming both, so no path is ever taken for a commit or a commit for a path. The parse lives here alone: the scheme may change (a URL form may come with the get_content consolidation).

The path runs to the end, or to the last : when what follows that is a range written <from>-<to> or <from>-, so a path may hold a :.

Fields

set: GovernanceLogId

A DATA-… id

commit: Option<GitCommitPrefix>

The commit cited, or None for the one the set pins as it stands (0.110.0)

path: DataFilePath

lines: Option<LineRange>

Implementations

impl DataCitation

pub const FORM: &'static str = "A data set's file is cited as \ DATA-YYYY-NNNN:<commit>:<path>, or \ DATA-YYYY-NNNN:<commit>:<path>:<from>-<to> for some of its lines; \ without a commit, for the one the set pins, the path starts with \ `/`: DATA-YYYY-NNNN:/<path> or DATA-YYYY-NNNN:/<path>:<from>-<to>. \ To read the data set itself, give its id alone."

How a citation is written, for error messages

pub fn is_citation_shaped(s: &str) -> bool

true when s starts with a DATA-… id and a :, so it is meant as a citation and its error is the one to show

pub fn reads_at(&self, commit: &GitCommitId) -> bool

true when this citation reads at commit: it names a prefix of it, or no commit at all (0.110.0)

pub fn at(self, commit: impl Into<GitCommitPrefix>) -> Self

This citation naming commit, its canonical form once the commit a commit-less one read at is known (0.110.0)

Trait Implementations

impl Clone for DataCitation

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DataCitation

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

Formats the value using the given formatter.

impl Display for DataCitation

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

Formats the value using the given formatter.

impl Eq for DataCitation

impl From<DataCitation> for ContentRef

fn from(c: DataCitation) -> Self

Converts to this type from the input type.

impl From<DataCitation> for AgoraLink

fn from(citation: DataCitation) -> Self

Converts to this type from the input type.

impl FromStr for DataCitation

type Err = DataCitationError

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.

impl Hash for DataCitation

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for DataCitation

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for DataCitation