Struct file_with_meta::FileHttpMetadata

pub struct FileHttpMetadata {
    pub format: MetadataFormat,
    pub file_size: u64,
    pub file_mtime: u64,
    pub hdr_last_modified: Option<String>,
    pub hdr_etag: Option<String>,
    pub source_file_size: Option<u64>,
    pub source_file_mtime: Option<u64>,
    pub verified: bool,
}

Information about a single file’s last modification time and, if specified, some relevant HTTP headers returned by the server that the file was fetched from.

Fields

format: MetadataFormat

The version of the metadata as stored in a JSON string.

file_size: u64

The size of the file.

file_mtime: u64

The modification time of the file as a Unix timestamp.

hdr_last_modified: Option<String>

The “Last-Modified” header as returned by an HTTP server.

hdr_etag: Option<String>

The “ETag” header as returned by an HTTP server.

source_file_size: Option<u64>

The size of the source file if applicable.

source_file_mtime: Option<u64>

The modification time of the source file if applicable.

verified: bool

A hook for external users to store information about whether the file’s contents has been validated.

Implementations

impl FileHttpMetadata

pub fn from_file<P>(path: P) -> Result<Self, Box<dyn Error>> where
    P: AsRef<Path>, 

Examine an existing file and return a metadata structure recording its size and last modification time.

pub fn from_file_with_source<P1, P2>(
    path: P1,
    src: P2
) -> Result<Self, Box<dyn Error>> where
    P1: AsRef<Path>,
    P2: AsRef<Path>, 

Examine an existing file and return a metadata structure recording its size and last modification time, as well as that of the specified “source” file.

pub fn from_file_with_source_meta<P>(
    path: P,
    src_meta: &FileHttpMetadata
) -> Result<Self, Box<dyn Error>> where
    P: AsRef<Path>, 

Examine an existing file and return a metadata structure recording its size and last modification time, as well as the previously-stored one for a “source” file.

pub fn parse(contents: &str) -> Result<Self, Box<dyn Error>>

Parse a metadata structure from the supplied JSON string. Verify the version specified in the “format” element, do not even attempt to parse unknown versions.

Trait Implementations

impl Debug for FileHttpMetadata

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

Formats the value using the given formatter.

impl Default for FileHttpMetadata

fn default() -> FileHttpMetadata

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for FileHttpMetadata

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl PartialEq<FileHttpMetadata> for FileHttpMetadata

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

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

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

This method tests for !=.

impl Serialize for FileHttpMetadata

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

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for FileHttpMetadata