Enum rust_releases_io::Document

pub enum Document {
    LocalPath(PathBuf),
    Memory(Vec<u8>),
    RemoteCached(PathBuf, Vec<u8>),
}

A Document represents a resource which can be used as an input to construct a ReleaseIndex.

Variants

LocalPath(PathBuf)

This variant can be used when the document is present on disk (e.g. if pulled from the cache), or accessible locally by following a path.

Memory(Vec<u8>)

This variant can be used when the document is present in memory

RemoteCached(PathBuf, Vec<u8>)

This variant can be used when the document has just been downloaded from a remote server, but had to be both written to disk, and used immediately (often in combination with something that implements Write).

The PathBuf represents the path to which the document contents were written (e.g. as cache). The Vec<u8> represents the document contents, so the just downloaded file doesn’t have to be written to the cache location, and read again.

Implementations

impl Document

pub fn load(&self) -> IoResult<Vec<u8>>

Load the document to a buffer consisting of bytes (u8).

Trait Implementations

impl Debug for Document

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

Formats the value using the given formatter.

impl Eq for Document

impl PartialEq<Document> for Document

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

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

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

This method tests for !=.

impl StructuralEq for Document

impl StructuralPartialEq for Document