Struct Dataset 

pub struct Dataset {

    pub id: String,
    pub line: usize,
    pub name: String,
    pub path: Option<String>,
    pub url: Option<String>,
    pub auth: Option<String>,
    pub connection: Option<String>,
    pub description: String,
    pub publisher: String,
    pub license: String,
    pub homepage: String,
    pub documentation: String,
    pub size: Option<u64>,
    pub columns: Vec<(String, ColumnNote)>,
    pub bookmarks: Vec<(String, String)>,
    pub base: Option<PathBuf>,
}

One dataset of a catalog: a local path or a remote url, never both.

Fields

id: String

The table’s key: short, unique in its catalog.

line: usize

Where its table starts in the file, for errors.

name: String

The row’s label.

path: Option<String>

url: Option<String>

auth: Option<String>

connection: Option<String>

description: String

publisher: String

license: String

homepage: String

documentation: String

The publisher’s documentation of the columns: the source of columns.

size: Option<u64>

About how many bytes an HTTP(S) file is, shown until it is measured.

columns: Vec<(String, ColumnNote)>

What each column means, by its name as the data spells it, in file order.

bookmarks: Vec<(String, String)>

Places inside a directory dataset to start from, by name, in file order.

base: Option<PathBuf>

The directory of the file that names it: a relative path is relative to it.

Implementations

impl Dataset

pub fn credit(&self) -> String

What a chart export credits as its source: the entry’s name, publisher and license, as the catalog gives them (NYC flights (2013), nycflights13 (CC0)).

pub fn local_path(&self) -> Option<PathBuf>

The local path with ~ and $VAR expanded, anchored at the catalog’s directory when it is relative.

pub fn location(&self) -> PathBuf

Where it is: the local path, expanded, or the URL.

pub fn location_text(&self) -> &str

The path or URL as written.

pub fn place_key(&self) -> String

What two entries naming the same data have in common.

pub fn bookmark_location(&self, path: &str) -> PathBuf

Where a bookmark is: its path under the dataset’s.

pub fn object_store_auth(&self) -> Option<DatasetAuth>

Whether a dataset in an object store, and how it is read: auto, anonymous, or a connection’s name. None for a path or a web file.

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 Default for Dataset

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for Dataset

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Dataset