Struct vf_rs::vf::Intent

pub struct Intent<PROCESS, AGENT, RESOURCESPECIFICATION, ECONOMICRESOURCE> { /* fields omitted */ }

A proposed or planned or estimated economic flow, prior to a commitment or agreement, which can lead to commitments and/or economic events.

ID: https://w3id.org/valueflows#Intent

Implementations

impl<PROCESS, AGENT, RESOURCESPECIFICATION, ECONOMICRESOURCE> Intent<PROCESS, AGENT, RESOURCESPECIFICATION, ECONOMICRESOURCE>

pub fn action(&self) -> &Action

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

pub fn agreed_in(&self) -> &Option<Url>

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

pub fn at_location(&self) -> &Option<SpatialThing>

The place where an intent, commitment, or economic event occurs. Usually mappable.

pub fn available_quantity(&self) -> &Option<Measure>

The quantity of the offered resource currently available.

pub fn due(&self) -> &Option<DateTime<Utc>>

The time something is expected to be complete.

pub fn effort_quantity(&self) -> &Option<Measure>

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(&self) -> &Option<bool>

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 has_beginning(&self) -> &Option<DateTime<Utc>>

The planned or actual beginning of a flow or process.

pub fn has_end(&self) -> &Option<DateTime<Utc>>

The planned or actual end of a flow or process.

pub fn has_point_in_time(&self) -> &Option<DateTime<Utc>>

The planned or actual time of a flow; can be used instead of hasBeginning and hasEnd, if so, hasBeginning and hasEnd should be able to be returned with this value.

pub fn image(&self) -> &Option<Url>

The uri to an image relevant to the entity, such as a logo, avatar, photo, diagram, etc.

pub fn in_scope_of(&self) -> &Vec<Url>

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

pub fn input_of(&self) -> &Option<PROCESS>

Relates an input flow to it's process.

pub fn name(&self) -> &Option<String>

An informal or formal textual identifier for an object. Does not imply uniqueness.

pub fn note(&self) -> &Option<String>

pub fn output_of(&self) -> &Option<PROCESS>

Relates an output flow to it's process.

pub fn provider(&self) -> &Option<AGENT>

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

pub fn receiver(&self) -> &Option<AGENT>

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

pub fn resource_classified_as(&self) -> &Vec<Url>

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

pub fn resource_conforms_to(&self) -> &Option<RESOURCESPECIFICATION>

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_inventoried_as(&self) -> &Option<ECONOMICRESOURCE>

Economic resource involved in the flow.

pub fn resource_quantity(&self) -> &Option<Measure>

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

impl<PROCESS, AGENT, RESOURCESPECIFICATION, ECONOMICRESOURCE> Intent<PROCESS, AGENT, RESOURCESPECIFICATION, ECONOMICRESOURCE>

pub fn set_action(&mut self, val: Action) -> &mut Self

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

pub fn set_agreed_in(&mut self, val: Option<Url>) -> &mut Self

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

pub fn set_at_location(&mut self, val: Option<SpatialThing>) -> &mut Self

The place where an intent, commitment, or economic event occurs. Usually mappable.

pub fn set_available_quantity(&mut self, val: Option<Measure>) -> &mut Self

The quantity of the offered resource currently available.

pub fn set_due(&mut self, val: Option<DateTime<Utc>>) -> &mut Self

The time something is expected to be complete.

pub fn set_effort_quantity(&mut self, val: Option<Measure>) -> &mut 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 set_finished(&mut self, val: Option<bool>) -> &mut 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 set_has_beginning(&mut self, val: Option<DateTime<Utc>>) -> &mut Self

The planned or actual beginning of a flow or process.

pub fn set_has_end(&mut self, val: Option<DateTime<Utc>>) -> &mut Self

The planned or actual end of a flow or process.

pub fn set_has_point_in_time(&mut self, val: Option<DateTime<Utc>>) -> &mut Self

The planned or actual time of a flow; can be used instead of hasBeginning and hasEnd, if so, hasBeginning and hasEnd should be able to be returned with this value.

pub fn set_image(&mut self, val: Option<Url>) -> &mut Self

The uri to an image relevant to the entity, such as a logo, avatar, photo, diagram, etc.

pub fn set_in_scope_of(&mut self, val: Vec<Url>) -> &mut Self

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

pub fn set_input_of(&mut self, val: Option<PROCESS>) -> &mut Self

Relates an input flow to it's process.

pub fn set_name(&mut self, val: Option<String>) -> &mut Self

An informal or formal textual identifier for an object. Does not imply uniqueness.

pub fn set_note(&mut self, val: Option<String>) -> &mut Self

pub fn set_output_of(&mut self, val: Option<PROCESS>) -> &mut Self

Relates an output flow to it's process.

pub fn set_provider(&mut self, val: Option<AGENT>) -> &mut Self

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

pub fn set_receiver(&mut self, val: Option<AGENT>) -> &mut Self

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

pub fn set_resource_classified_as(&mut self, val: Vec<Url>) -> &mut Self

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

pub fn set_resource_conforms_to(
    &mut self,
    val: Option<RESOURCESPECIFICATION>
) -> &mut 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 set_resource_inventoried_as(
    &mut self,
    val: Option<ECONOMICRESOURCE>
) -> &mut Self

Economic resource involved in the flow.

pub fn set_resource_quantity(&mut self, val: Option<Measure>) -> &mut Self

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

impl<PROCESS, AGENT, RESOURCESPECIFICATION, ECONOMICRESOURCE> Intent<PROCESS, AGENT, RESOURCESPECIFICATION, ECONOMICRESOURCE>

pub fn action_mut(&mut self) -> &mut Action

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

pub fn agreed_in_mut(&mut self) -> &mut Option<Url>

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

pub fn at_location_mut(&mut self) -> &mut Option<SpatialThing>

The place where an intent, commitment, or economic event occurs. Usually mappable.

pub fn available_quantity_mut(&mut self) -> &mut Option<Measure>

The quantity of the offered resource currently available.

pub fn due_mut(&mut self) -> &mut Option<DateTime<Utc>>

The time something is expected to be complete.

pub fn effort_quantity_mut(&mut self) -> &mut Option<Measure>

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_mut(&mut self) -> &mut Option<bool>

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 has_beginning_mut(&mut self) -> &mut Option<DateTime<Utc>>

The planned or actual beginning of a flow or process.

pub fn has_end_mut(&mut self) -> &mut Option<DateTime<Utc>>

The planned or actual end of a flow or process.

pub fn has_point_in_time_mut(&mut self) -> &mut Option<DateTime<Utc>>

The planned or actual time of a flow; can be used instead of hasBeginning and hasEnd, if so, hasBeginning and hasEnd should be able to be returned with this value.

pub fn image_mut(&mut self) -> &mut Option<Url>

The uri to an image relevant to the entity, such as a logo, avatar, photo, diagram, etc.

pub fn in_scope_of_mut(&mut self) -> &mut Vec<Url>

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

pub fn input_of_mut(&mut self) -> &mut Option<PROCESS>

Relates an input flow to it's process.

pub fn name_mut(&mut self) -> &mut Option<String>

An informal or formal textual identifier for an object. Does not imply uniqueness.

pub fn note_mut(&mut self) -> &mut Option<String>

pub fn output_of_mut(&mut self) -> &mut Option<PROCESS>

Relates an output flow to it's process.

pub fn provider_mut(&mut self) -> &mut Option<AGENT>

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

pub fn receiver_mut(&mut self) -> &mut Option<AGENT>

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

pub fn resource_classified_as_mut(&mut self) -> &mut Vec<Url>

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

pub fn resource_conforms_to_mut(&mut self) -> &mut Option<RESOURCESPECIFICATION>

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_inventoried_as_mut(&mut self) -> &mut Option<ECONOMICRESOURCE>

Economic resource involved in the flow.

pub fn resource_quantity_mut(&mut self) -> &mut Option<Measure>

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

impl<PROCESS, AGENT, RESOURCESPECIFICATION, ECONOMICRESOURCE> Intent<PROCESS, AGENT, RESOURCESPECIFICATION, ECONOMICRESOURCE>

pub fn builder(
) -> IntentBuilder<PROCESS, AGENT, RESOURCESPECIFICATION, ECONOMICRESOURCE>

Create an empty builder object for Intent

pub fn into_builder(
    self
) -> IntentBuilder<PROCESS, AGENT, RESOURCESPECIFICATION, ECONOMICRESOURCE>

Turns Intent into IntentBuilder

Trait Implementations

impl<PROCESS: Clone, AGENT: Clone, RESOURCESPECIFICATION: Clone, ECONOMICRESOURCE: Clone> Clone for Intent<PROCESS, AGENT, RESOURCESPECIFICATION, ECONOMICRESOURCE>

fn clone(
    &self
) -> Intent<PROCESS, AGENT, RESOURCESPECIFICATION, ECONOMICRESOURCE>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<PROCESS: Debug, AGENT: Debug, RESOURCESPECIFICATION: Debug, ECONOMICRESOURCE: Debug> Debug for Intent<PROCESS, AGENT, RESOURCESPECIFICATION, ECONOMICRESOURCE>

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

Formats the value using the given formatter.

impl<'de, PROCESS, AGENT, RESOURCESPECIFICATION, ECONOMICRESOURCE> Deserialize<'de> for Intent<PROCESS, AGENT, RESOURCESPECIFICATION, ECONOMICRESOURCE> where
    PROCESS: Deserialize<'de>,
    AGENT: Deserialize<'de>,
    RESOURCESPECIFICATION: Deserialize<'de>,
    ECONOMICRESOURCE: Deserialize<'de>, 

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

Deserialize this value from the given Serde deserializer.

impl<PROCESS: PartialEq, AGENT: PartialEq, RESOURCESPECIFICATION: PartialEq, ECONOMICRESOURCE: PartialEq> PartialEq<Intent<PROCESS, AGENT, RESOURCESPECIFICATION, ECONOMICRESOURCE>> for Intent<PROCESS, AGENT, RESOURCESPECIFICATION, ECONOMICRESOURCE>

fn eq(
    &self,
    other: &Intent<PROCESS, AGENT, RESOURCESPECIFICATION, ECONOMICRESOURCE>
) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(
    &self,
    other: &Intent<PROCESS, AGENT, RESOURCESPECIFICATION, ECONOMICRESOURCE>
) -> bool

This method tests for !=.

impl<PROCESS, AGENT, RESOURCESPECIFICATION, ECONOMICRESOURCE> Serialize for Intent<PROCESS, AGENT, RESOURCESPECIFICATION, ECONOMICRESOURCE> where
    PROCESS: Serialize,
    AGENT: Serialize,
    RESOURCESPECIFICATION: Serialize,
    ECONOMICRESOURCE: Serialize, 

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

Serialize this value into the given Serde serializer.

impl<PROCESS, AGENT, RESOURCESPECIFICATION, ECONOMICRESOURCE> StructuralPartialEq for Intent<PROCESS, AGENT, RESOURCESPECIFICATION, ECONOMICRESOURCE>