Struct dochy_archiver::ArchiveOptions

pub struct ArchiveOptions { /* fields omitted */ }

Customize how we build the archive.

If you need the default value, you can get it with new()

use dochy_archiver::ArchiveOptions;

// construct with the default values.
// In the default configuration, every file is archived in the folder and the subfolders.
let op = ArchiveOptions::new();

If you want to customize, you can use the builder.

Appending "..Default::default()" could make your source code compatible with the future versions of this library.

use dochy_archiver::ArcResult;
use dochy_archiver::{ArchiveOptions, ArchiveOptionsBuilder};

fn main() -> ArcResult<()>{
let op = ArchiveOptions::from(
        ArchiveOptionsBuilder {
            extensions_archived : vec![".json5"],
            archive_subfolders : false,
            ..Default::default()
       })?;
    Ok(())
}

Implementations

impl ArchiveOptions

pub fn is_archived(&self, extension: &str) -> bool

Should the file with the extension be archived?

pub fn archive_subfolders(&self) -> bool

Should the subfolders be archived?

pub fn new() -> ArchiveOptions

construct with the default values. In the default configuration, every file is archived in the folder and the subfolders.

pub fn from(builder: ArchiveOptionsBuilder<'_>) -> ArcResult<ArchiveOptions>

Construct ArchiveOptions from the builder

Trait Implementations

impl Clone for ArchiveOptions

fn clone(&self) -> ArchiveOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ArchiveOptions

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

Formats the value using the given formatter.