summaryrefslogtreecommitdiffstats
path: root/ipfs-api-prelude/src/request/add.rs
blob: 889c617f71e634613275c821d39b71e9553369a9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
// Copyright 2017 rust-ipfs-api Developers
//
// Licensed under the Apache License, Version 2.0, <LICENSE-APACHE or
// http://apache.org/licenses/LICENSE-2.0> or the MIT license <LICENSE-MIT or
// http://opensource.org/licenses/MIT>, at your option. This file may not be
// copied, modified, or distributed except according to those terms.
//

use crate::request::ApiRequest;
use serde::Serialize;

#[cfg_attr(feature = "with-builder", derive(TypedBuilder))]
#[derive(Serialize, Default)]
#[serde(rename_all = "kebab-case")]
pub struct Add<'a> {
    /// Use trickle-dag format for dag generation.
    #[cfg_attr(feature = "with-builder", builder(default, setter(strip_option)))]
    pub trickle: Option<bool>,

    /// Only chunk and hash - do not write to disk.
    #[cfg_attr(feature = "with-builder", builder(default, setter(strip_option)))]
    pub only_hash: Option<bool>,

    /// Wrap files with a directory object.
    #[cfg_attr(feature = "with-builder", builder(default, setter(strip_option)))]
    pub wrap_with_directory: Option<bool>,

    /// Chunking algorithm, `size-[bytes]`, `rabin-[min]-[avg]-[max]` or `buzhash`.
    #[cfg_attr(feature = "with-builder", builder(default, setter(strip_option)))]
    pub chunker: Option<&'a str>,

    /// Pin this object when adding. Defaults to `true`.
    #[cfg_attr(feature = "with-builder", builder(default, setter(strip_option)))]
    pub pin: Option<bool>,

    /// Use raw blocks for leaf nodes. (experimental).
    #[cfg_attr(feature = "with-builder", builder(default, setter(strip_option)))]
    pub raw_leaves: Option<bool>,

    /// CID version. Defaults to 0 unless an option that depends on CIDv1 is passed.
    /// (experimental).
    #[cfg_attr(feature = "with-builder", builder(default, setter(strip_option)))]
    pub cid_version: Option<u32>,

    /// Hash function to use. Implies CIDv1 if not sha2-256. (experimental). Default:
    /// `sha2-256`.
    #[cfg_attr(feature = "with-builder", builder(default, setter(strip_option)))]
    pub hash: Option<&'a str>,

    /// Inline small blocks into CIDs. (experimental).
    #[cfg_attr(feature = "with-builder", builder(default, setter(strip_option)))]
    pub inline: Option<bool>,

    /// Maximum block size to inline. (experimental). Default: `32`.
    #[cfg_attr(feature = "with-builder", builder(default, setter(strip_option)))]
    pub inline_limit: Option<u32>,
}

impl<'a> ApiRequest for Add<'a> {
    const PATH: &'static str = "/add";
}