Struct specifications::data::AssetInfo

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

Defines a single AssetInfo file that describes a dataset but for a user-facing user.

Fields

name: String

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

owners: Option<Vec<String>>

The list of owners of this asset. This is not the domains, but rather the physical people who added it and such.

description: Option<String>

A (short) description of the asset.

created: DateTime<Utc>

The created timestamp of the asset.

access: AccessKind

Defines the way how to access & distribute this asset to containers.

Implementations

impl AssetInfo

pub fn from_path(path: impl AsRef<Path>) -> Result<Self, AssetInfoError>

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

Arguments

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

Returns

A new AssetInfo 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, AssetInfoError>

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

Generic arguments

• R: The read-capable type to read from.

Arguments

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

Returns

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

Errors

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

pub fn into_data_info(self, location: impl Into<String>) -> DataInfo

Converts this AssetInfo into a DataInfo under the given domain.

Arguments

• location: The name of the location where this AssetInfo came from.

Returns

A new DataInfo instance that contains the same information as this AssetInfo but ordered differently.

Trait Implementations

impl Clone for AssetInfo

fn clone(&self) -> AssetInfo

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AssetInfo

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for AssetInfo

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 AssetInfo

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

where __S: Serializer,

Serialize this value into the given Serde serializer.