matthiasbeyer/imag
1
0
Fork 0
Code Releases Activity

Add docs to FileID

Browse source
This commit is contained in:
Matthias Beyer 2015-12-29 17:35:51 +01:00
parent 6bcfc0a4b2
commit d34143e516
1 changed files with 18 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
src/storage/file/id.rs
View file

@ -16,6 +16,15 @@ use storage::file::hash::FileHash;
#[derive(Hash)] #[derive(Hash)]
#[derive(Eq)] #[derive(Eq)]
#[derive(PartialEq)] #[derive(PartialEq)]
/**
* FileID
*
* A FileID contains of two parts: The ID type and the Hash. For example the FileID
*
* UUID-235-1215-1212
*
* has a type ("UUID") and a Hash ("235-1215-1212").
*/
pub struct FileID { pub struct FileID {
id: FileHash, id: FileHash,
id_type: FileIDType, id_type: FileIDType,
@ -30,14 +39,23 @@ impl FileID {
} }
} }
/**
* Get the type of the FileID
*/
pub fn get_type(&self) -> FileIDType { pub fn get_type(&self) -> FileIDType {
self.id_type.clone() self.id_type.clone()
} }
/**
* Get the Hash of the FileID
*/
pub fn get_id(&self) -> FileHash { pub fn get_id(&self) -> FileHash {
self.id.clone() self.id.clone()
} }
/**
* Parse a String into a FileID, if possible
*/
pub fn parse(string: &String) -> Option<FileID> { pub fn parse(string: &String) -> Option<FileID> {
// we assume that it is an path // we assume that it is an path
let regex = Regex::new(r"([:alnum:]*)-([:upper:]*)-([A-Za-z0-9-_]*)\.(.*)").unwrap(); let regex = Regex::new(r"([:alnum:]*)-([:upper:]*)-([A-Za-z0-9-_]*)\.(.*)").unwrap();