Struct rman::File

pub struct File {
    pub id: i64,
    pub name: String,
    pub permissions: u8,
    pub size: u32,
    pub path: String,
    pub symlink: String,
    pub tags: Vec<String>,
    /* private fields */
}

Single file object.

Represents a file and it’s properties that can be downloaded and written to a file system.

Fields

id: i64

Id of the file.

name: String

File name.

permissions: u8

Permissions for the given file.

size: u32

Size of the file entry in bytes.

path: String

Absolute path to the file, where root is one of the directory entries.

symlink: String

Symbolic link of the file.

tags: Vec<String>

A vector of applicable tags.

Implementations

impl File

pub fn parse( file: &FileEntry, tag_entries: &HashMap<u8, String>, directories: &HashMap<i64, (String, i64)>, chunk_entries: &HashMap<i64, (i64, u32, u32, u32)> ) -> Result<Self>

Parses FileEntry into a File object.

First parameter is a FileEntry that is parsed into a File, the other three are HashMaps used for fast lookups for the required data.

Here is how they are structured:

• Parameter tag_entries is a HashMap where the key is a tag id and the value is a tag name.

• Parameter directories is a HashMap where the key is a directory id and the value is a tuple of:

  • directory name
  • and parent directory id.

• Parameter chunk_entries is a HashMap where the key is a chunk id and the value is a tuple of:

  • bundle id,
  • offset in bundle (to this specific chunk),
  • uncompressed size
  • and compressed size.

Errors

If a directory with provided id or parent id does not exist within the directories HashMap, or if a chunk with chunk id does not exist within the chunk_entries HashMap, the error FileParseError is returned.

impl File

pub async fn download<W: Write + Send, U: IntoUrl + Send>( &self, writer: W, bundle_url: U ) -> Result<()>

Function to download the associated file contents.

This is done by looping through all of the chunks of this file, and for each loop:

• get the bundle id it belongs to, and convert it to hexadecimal value with a fixed size of 16 (if the length is less than 16, zeros are padded to the left).
• download the chunk from the url using the range header
• decompress the chunk
• write chunk.

Errors

If downloading fails, the error ReqwestError is returned.

If converting uncompressed_size to usize fails, the error ConversionFailure is returned.

If zstd decompression fails, the error ZstdDecompressError is returned.

If writing to io stream fails, the error IoError is returned.

Examples

See downloading a file.

Trait Implementations

impl Clone for File

fn clone(&self) -> File

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for File

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

Formats the value using the given formatter.

impl Default for File

fn default() -> File

Returns the “default value” for a type.

impl PartialEq<File> for File

fn eq(&self, other: &File) -> 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 Eq for File

impl StructuralEq for File

impl StructuralPartialEq for File