Struct vf_rs::vf::builders::ClaimBuilder

pub struct ClaimBuilder<AGENT, RESOURCESPECIFICATION, ECONOMICEVENT> { /* fields omitted */ }

Builder for Claim.

Implementations

impl<AGENT, RESOURCESPECIFICATION, ECONOMICEVENT> ClaimBuilder<AGENT, RESOURCESPECIFICATION, ECONOMICEVENT>

pub fn action<VALUE: Into<Action>>(self, value: VALUE) -> Self

Defines the kind of flow, such as consume, produce, work, transfer, etc.

pub fn agreed_in<VALUE: Into<Url>>(self, value: VALUE) -> Self

Reference to an agreement between agents which specifies the rules, terms, policies, calculations, etc. which govern this flow.

pub fn created<VALUE: Into<DateTime<Utc>>>(self, value: VALUE) -> Self

pub fn due<VALUE: Into<DateTime<Utc>>>(self, value: VALUE) -> Self

The time something is expected to be complete.

pub fn effort_quantity<VALUE: Into<Measure>>(self, value: VALUE) -> Self

The amount and unit of the work or use or citation effort-based action. This is often a time duration, but also could be cycle counts or other measures of effort or usefulness.

pub fn finished<VALUE: Into<bool>>(self, value: VALUE) -> Self

The commitment or intent or process is complete or not. This is irrespective of if the original goal has been met, and indicates that no more will be done.

pub fn in_scope_of<VALUE: Into<Vec<Url>>>(self, value: VALUE) -> Self

Grouping around something to create a boundary or context, used for documenting, accounting, planning.

pub fn note<VALUE: Into<String>>(self, value: VALUE) -> Self

pub fn provider<VALUE: Into<AGENT>>(self, value: VALUE) -> Self

The economic agent from whom the intended, committed, or actual economic event is initiated.

pub fn receiver<VALUE: Into<AGENT>>(self, value: VALUE) -> Self

The economic agent whom the intended, committed, or actual economic event is for.

pub fn resource_classified_as<VALUE: Into<Vec<Url>>>(self, value: VALUE) -> Self

References a concept in a common taxonomy or other classification scheme for purposes of categorization or grouping.

pub fn resource_conforms_to<VALUE: Into<RESOURCESPECIFICATION>>(
    self,
    value: VALUE
) -> Self

The primary resource specification or definition of an existing or potential economic resource. A resource will have only one, as this specifies exactly what the resource is.

pub fn resource_quantity<VALUE: Into<Measure>>(self, value: VALUE) -> Self

The amount and unit of the economic resource counted or inventoried.

pub fn triggered_by<VALUE: Into<ECONOMICEVENT>>(self, value: VALUE) -> Self

References an economic event that implied the claim or event, often based on a prior agreement.

pub fn build(
    self
) -> Result<Claim<AGENT, RESOURCESPECIFICATION, ECONOMICEVENT>, String>

Builds a new Claim.

Errors

If a required field has not been initialized.

Trait Implementations

impl<AGENT: Default, RESOURCESPECIFICATION: Default, ECONOMICEVENT: Default> Default for ClaimBuilder<AGENT, RESOURCESPECIFICATION, ECONOMICEVENT>

fn default() -> ClaimBuilder<AGENT, RESOURCESPECIFICATION, ECONOMICEVENT>

Returns the "default value" for a type.