Struct DataSet 

pub struct DataSet {
    pub agora_data_set: u32,
    pub title: String,
    pub description: String,
    pub compiled_by: String,
    pub repo: DataRepoName,
    pub commit: GitCommitId,
    pub index: DataFilePath,
    pub files: Vec<DataFile>,
}

The data of a data_set entry. See the module docs.

Unknown keys are tolerated, as on a record: a stored manifest also carries the writer’s _blind.

Fields

agora_data_set: u32

Always DATA_SET_VERSION

title: String

description: String

What the data is, where it came from and how to read it (markdown)

compiled_by: String

Who compiled it, in their own words

repo: DataRepoName

The data repository’s name, as it is cloned (agora-data). Each data set may have its own repository (0.103): a server reads it at <its data repositories>/<repo>.git

commit: GitCommitId

The commit every file is read at

index: DataFilePath

The file a reader should open first; one of files

files: Vec<DataFile>

Every file a server may serve, sorted by path

Implementations

impl DataSet

pub fn validate(&self) -> Result<(), &'static str>

What a writer refuses to sign: another version, a blank text field, no files, paths out of order or repeated, an index that is not listed, or a note that is blank or more than one line

pub fn file(&self, path: &DataFilePath) -> Option<&DataFile>

The listed file at path, if it is listed

pub fn total_bytes(&self) -> u64

Every file’s size, added up

pub fn under(&self, prefix: &str) -> (u64, u64)

The files under prefix (a directory ending in /): how many, and their bytes added up

pub fn resolve( &self, asked: &str, ) -> Result<DataSetTarget<'_>, DataSetLookupError>

What attachment=<asked> names: a listed file, or a directory (ending in /). Paths are relative to the repository root; one relative to a directory at the root (README.md for votes/README.md, the way a set’s own files cite each other) resolves when exactly one directory holds it, and the target says what was asked (asked is set only then). Surrounding whitespace and a leading ./ or / are ignored. (0.91.4)

impl DataSet

pub fn resolve_ranged( &self, asked: &str, ) -> Option<Result<(DataSetTarget<'_>, Result<LineRange, LineRangeError>), DataSetLookupError>>

asked read as <file>:<range>, for an asked that names nothing as it stands: when the part before its last : names a listed file, that file and the part after read as a LineRange, with the errors lines= gives. None when it does not, or when what follows the : does not look like a range (notes.md:v2), so the caller’s own miss stands. A file part that names several files is that error (0.105.0)

A citation’s range is parsed strictly (<from>-<to>), so a path such as log:12 stays a path; here the listing has settled that no such file exists, and rubric.md:8-3 or rubric.md:8 is a range of rubric.md, refused or read as written.

Trait Implementations

impl Clone for DataSet

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 DataSet

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DataSet

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for DataSet

impl PartialEq for DataSet

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for DataSet

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for DataSet