Struct DocumentCreateCost 

pub struct DocumentCreateCost {

    pub document_type: String,
    pub assumptions: CostAssumptions,
    pub document_bytes: u64,
    pub credits_per_byte: Credits,
    pub elements: Vec<ElementCost>,
    pub primary_bytes: Scenarios,
    pub preallocated_bytes: Scenarios,
    pub expiration_bytes: Scenarios,
    pub indexes: Vec<IndexCost>,
    pub storage_bytes: Scenarios,
    pub storage_credits: Scenarios,
    pub processing: Vec<ProcessingCost>,
    pub contract_charges: Vec<ContractCharge>,
    pub refund_same_epoch: Option<Scenarios>,
    pub refund_after_one_year: Option<Scenarios>,
    pub fields: Vec<FieldSize>,
}

What creating one document of a type costs.

Fields

document_type: String

The document type name.

assumptions: CostAssumptions

What the estimate assumes.

document_bytes: u64

The serialized document, in bytes.

credits_per_byte: Credits

Credits per stored byte.

elements: Vec<ElementCost>

Every element the insert writes.

primary_bytes: Scenarios

The bytes of primary storage (the document by id).

preallocated_bytes: Scenarios

The bytes of the trees preallocated for entries of other types that will reference the document.

expiration_bytes: Scenarios

The bytes of a document with a ttl’s entry in the documents expirations tree.

indexes: Vec<IndexCost>

The bytes each index adds.

storage_bytes: Scenarios

All the storage bytes.

storage_credits: Scenarios

The storage fee.

processing: Vec<ProcessingCost>

The processing fee, part by part (the fee increase included).

contract_charges: Vec<ContractCharge>

What the contract adds.

refund_same_epoch: Option<Scenarios>

The storage fee a delete in the same epoch refunds (with the fee-distribution feature).

refund_after_one_year: Option<Scenarios>

The storage fee a delete a year (an era of epochs) later refunds (with the fee-distribution feature).

fields: Vec<FieldSize>

How each field of the priced document was filled, when it was built from sizes (document_type_create_cost).

Implementations

impl DocumentCreateCost

pub fn processing_credits(&self) -> Scenarios

The processing fee.

pub fn total_credits(&self) -> Scenarios

The credits the create costs in fees and action fees, without a token cost or a contest fund.

impl DocumentCreateCost

pub fn to_value(&self) -> Value

The estimate as a plain value, amounts in credits, a key left out when it has no value: { documentType, assumptions, documentBytes, creditsPerByte, creditsPerDash, storage: { bytes, credits, primaryBytes }, indexes, elements, processing, processingCredits, contractCharges, refund: { sameEpoch, afterOneYear }, totalCredits }; every amount that depends on the scenario is { newValues, knownValues }.

Trait Implementations

impl Clone for DocumentCreateCost

fn clone(&self) -> DocumentCreateCost

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DocumentCreateCost

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

Formats the value using the given formatter.

impl PartialEq for DocumentCreateCost

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for DocumentCreateCost