Struct simuldb::Dataset

pub struct Dataset {
    pub id: Uuid,
    pub hash: Vec<u8>,
    /* private fields */
}

Reference to one data file

This stores an id to identify to file, a hash to verify it and some metadata that is associated with the data. Note that this does not specify exactly where the file is stored.

By default sha2 is used to generate a SHA-512 hash of the file if the sha feature is enabled. Manually calculating the hash and using from_hash allows for other hash functions as long as the hash is representable as Vec<u8>.

Every time that is serializable into a Map can be used as metadata.

Fields

id: Uuid

Id of file

hash: Vec<u8>

Hash of file

Implementations

impl Dataset

pub fn from_hash<S: Serialize + Debug>( hash: Vec<u8>, metadata: S, id: Option<Uuid> ) -> Result<Self>

Generate dataset object from externally calculated hash

If no id is specified, a random one will be generated

Arguments

• hash: hash of the data file
• metadata: associated metadata, has to be serializable to a Map
• id: id of the file

pub fn from_file<P: AsRef<Path>, S: Serialize + Debug>( path: P, metadata: S, id: Option<Uuid> ) -> Result<Self>

Available on crate feature sha only.

Generate dataset object by calulating the SHA-512 hash of an existing file

If no id is specified, a random one will be generated

Arguments

• path: path to the data file
• metadata: associated metadata, has to be serializable to a Map
• id: id of the file

Trait Implementations

impl<'arbitrary> Arbitrary<'arbitrary> for Dataset

fn arbitrary(u: &mut Unstructured<'arbitrary>) -> Result<Self>

Generate an arbitrary value of Self from the given unstructured data.

fn arbitrary_take_rest(u: Unstructured<'arbitrary>) -> Result<Self>

Generate an arbitrary value of Self from the entirety of the given unstructured data.

fn size_hint(depth: usize) -> (usize, Option<usize>)

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

impl Clone for Dataset

fn clone(&self) -> Dataset

Returns a copy 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 Ord for Dataset

fn cmp(&self, other: &Dataset) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for Dataset

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Dataset

fn partial_cmp(&self, other: &Dataset) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= 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 Eq for Dataset

impl StructuralEq for Dataset

impl StructuralPartialEq for Dataset