Struct ibdl_core::queue::summary::SummaryFile

pub struct SummaryFile {
    pub file_mode: SummaryType,
    pub imageboard: ImageBoards,
    pub name_mode: NameType,
    pub tags: Vec<String>,
    pub last_updated: DateTime<Utc>,
    pub last_downloaded: u64,
    pub posts: Vec<PostInfo>,
}

The final summary file. It containes common information for the user to read and the necessary data to filter posts in certain occasions.

Fields

file_mode: SummaryType

imageboard: ImageBoards

name_mode: NameType

tags: Vec<String>

last_updated: DateTime<Utc>

last_downloaded: u64

posts: Vec<PostInfo>

Implementations

impl SummaryFile

pub fn new(
    imageboard: ImageBoards,
    tags: &[String],
    posts: &[Post],
    name_mode: NameType,
    file_mode: SummaryType
) -> Self

Create a SummaryFile from the supplied information about all downloaded posts.

pub fn write_zip_summary(
    &self,
    zip: &mut ZipWriter<File>
) -> Result<(), QueueError>

Writes this struct as a summary file inside a supplied zip file.

pub async fn write_summary(&self, path: &Path) -> Result<(), QueueError>

Writes this struct as a summary file in the given Path.

pub async fn read_summary(
    path: &Path,
    summary_type: SummaryType
) -> Result<Self, QueueError>

Read the summary file from the supplied Path.

pub fn from_bincode(slice: &[u8]) -> Result<Self, QueueError>

Read the bincode summary and decode it into a SummaryFile

pub fn from_json_slice(slice: &[u8]) -> Result<Self, QueueError>

Read the summary as a raw JSON slice from and decode it into a SummaryFile

pub fn from_json_str(text: &str) -> Result<Self, QueueError>

Read the summary as a raw JSON string and decode it into a SummaryFile

pub async fn read_zip_summary(
    path: &Path,
    summary_type: SummaryType
) -> Result<Self, QueueError>

pub fn to_json(&self) -> Result<String, QueueError>

pub fn to_bincode(&self) -> Result<Vec<u8>, QueueError>

Trait Implementations

impl Debug for SummaryFile

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SummaryFile

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

Deserialize this value from the given Serde deserializer.

impl Serialize for SummaryFile

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

Serialize this value into the given Serde serializer.