Struct specifications::data::DataInfo

pub struct DataInfo {
    pub name: String,
    pub owners: Option<Vec<String>>,
    pub description: Option<String>,
    pub created: DateTime<Utc>,
    pub access: HashMap<Location, AccessKind>,
}

Defines a single DataInfo file that describes a dataset and how to access it.

Fields

name: String

Defines the name (=identifier) of the DataInfo. Must be unique across the instance.

owners: Option<Vec<String>>

The list of owners of this asset.

description: Option<String>

A (short) description of the asset.

created: DateTime<Utc>

The created timestamp of the asset.

access: HashMap<Location, AccessKind>

Defines how to access this DataInfo per location that advertises it.

Implementations

impl DataInfo

pub fn from_path<P: AsRef<Path>>(path: P) -> Result<Self, DataInfoError>

Constructor for the DataInfo that reads it from the given path.

Generic arguments

• P: The &Path-like type of the path.

Arguments

• path: The path from which we will read the DataInfo.

Returns

A new DataInfo instance representing the asset described in the given file.

Errors

This function errors if we could not read or parse the file.

pub fn from_reader<R: Read>(reader: R) -> Result<Self, DataInfoError>

Constructor for the DataInfo that reads it from the given reader.

Generic arguments

• R: The Read-enabled type of the reader.

Arguments

• reader: The reader from which we will read the DataInfo.

Returns

A new DataInfo instance representing the asset described in the given reader.

Errors

This function errors if we could not read or parse the reader.

pub fn to_path(&self, path: impl AsRef<Path>) -> Result<(), DataInfoError>

Writes the DataInfo to the given path.

Arguments

• path: The path to write the DataInfo to.

Returns

Nothing, but does write a new file at the given path.

Errors

This function errors if we could not create or write to the new file.

pub fn to_writer(&self, writer: impl Write) -> Result<(), DataInfoError>

Writes the DataInfo to the given writer.

Arguments

• writer The Writer to write the DataInfo to.

Returns

Nothing, but does write the DataInfo to the given writer.

Errors

This function errors if we could not write to the given writer.

Trait Implementations

impl Clone for DataInfo

fn clone(&self) -> DataInfo

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DataInfo

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DataInfo

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<AssetInfo> for DataInfo

fn from(value: AssetInfo) -> Self

Converts to this type from the input type.

impl Serialize for DataInfo

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

Serialize this value into the given Serde serializer.