Struct DatasetPath 

pub struct DatasetPath {
    pub path: String,
    pub directory: bool,
    pub grantable: bool,
    pub available: bool,
    pub desc: String,
    pub format: String,
    pub examples: Vec<String>,
    pub public: bool,
    pub wording: String,
}

DatasetPath describes one path pattern under the data root. A segment in angle brackets is a placeholder, described by the directory entry it names. The path is the entry’s stable key.

A grantable path also carries its wording and whether it is public. A public path reads nothing about the owner’s DNA, such as the reference genome or which datasets are uploaded. The wording is an English template that describes a grant to the owner, with each placeholder named after the path’s own, such as “Your genome around variant {rsid}”.

Fields

path: String

Path as a manifest names it

directory: bool

Directory or file

grantable: bool

Whether a manifest may name it

available: bool

Whether the data this path needs is on the Ark now

desc: String

What it holds, when it is absent and when it fails

format: String

Exact file content, or what a directory lists

examples: Vec<String>

Complete example values, most typical first

public: bool

Whether a grant reads nothing about the owner’s DNA, for grantable paths

wording: String

Template wording a grant to the owner, for grantable paths

Trait Implementations

impl Clone for DatasetPath

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 DatasetPath

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

Formats the value using the given formatter.

impl Default for DatasetPath

fn default() -> Self

Returns the “default value” for a type.

impl Eq for DatasetPath

impl Hash for DatasetPath

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 Message for DatasetPath

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for DatasetPath

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for DatasetPath