Struct Workflow 

pub struct Workflow<Vocab: ActivityVocabulary = VocabularyTypes> { /* private fields */ }

Manages a set of custom labels and properties of tickets and MRs, as well as the possible transitions between property values.

Example (single vocabulary type)

use activityforge::{Workflow, context};
use activitystreams_vocabulary::{
    Iri, MultibaseHeader, MultibasePublicKey, Multikey, MultikeyPublicKey, Name,
};

let id = Iri::try_from("https://dev.example/aviva/treesim").unwrap();
let name = Name::try_from("Tree Growth 3D Simulation").unwrap();
let summary = "<p>Tree growth 3D simulator for my nature exploration game</p>";
let inbox = Iri::try_from("https://dev.example/aviva/treesim/inbox").unwrap();
let outbox = Iri::try_from("https://dev.example/aviva/treesim/outbox").unwrap();
let followers = Iri::try_from("https://dev.example/aviva/treesim/followers").unwrap();

let key_id = Iri::try_from("https://dev.example/aviva/treesim#main-key").unwrap();
let controller = Iri::try_from("https://dev.example/aviva/treesim").unwrap();
let encoded_multibase = "u7QGwDY2Tjn93PVFWWq02piP1NE9_XRlg-c8-jhJiHqKBHw";

let team = Iri::try_from("https://dev.example/aviva/treesim/team").unwrap();

let json_str = format!(
r#"{{
  "@context": [
    "https://www.w3.org/ns/activitystreams",
    "https://forgefed.org/ns"
  ],
  "type": "Workflow",
  "id": "{id}",
  "name": "{name}",
  "summary": "{summary}",
  "inbox": "{inbox}",
  "outbox": "{outbox}",
  "followers": "{followers}",
  "assertionMethod": [
    {{
      "type": "Multikey",
      "id": "{key_id}",
      "controller": "{controller}",
      "publicKeyMultibase": "{encoded_multibase}"
    }}
  ]
}}"#
        );

let context = context::forgefed_context();

let multibase = MultibasePublicKey::new()
    .with_header(MultibaseHeader::Base64UrlNoPad)
    .with_key(MultikeyPublicKey::Ed25519([
        0xb0, 0x0d, 0x8d, 0x93, 0x8e, 0x7f, 0x77, 0x3d, 0x51, 0x56, 0x5a, 0xad, 0x36, 0xa6,
        0x23, 0xf5, 0x34, 0x4f, 0x7f, 0x5d, 0x19, 0x60, 0xf9, 0xcf, 0x3e, 0x8e, 0x12, 0x62,
        0x1e, 0xa2, 0x81, 0x1f,
    ]));

let multikey = Multikey::new_inner()
    .with_id(key_id)
    .with_controller(controller.clone())
    .with_public_key_multibase(multibase);

let repository = Workflow::new()
    .with_context_property(context)
    .with_id(id)
    .with_name(name)
    .with_summary(summary)
    .with_inbox(inbox)
    .with_outbox(outbox)
    .with_followers(followers)
    .with_assertion_method([multikey]);

assert_eq!(serde_json::to_string_pretty(&repository).unwrap(), json_str);
assert_eq!(
    serde_json::from_str::<Workflow>(json_str.as_str()).unwrap(),
    repository
);

Example (list of vocabulary types)

use activityforge::{ActorType, Workflow, VocabularyTypes, context};
use activitystreams_vocabulary::{
    Iri, MultibaseHeader, MultibasePublicKey, Multikey, MultikeyPublicKey, Name,
};

let id = Iri::try_from("https://dev.example/aviva/treesim").unwrap();
let name = Name::try_from("Tree Growth 3D Simulation").unwrap();
let summary = "<p>Tree growth 3D simulator for my nature exploration game</p>";
let inbox = Iri::try_from("https://dev.example/aviva/treesim/inbox").unwrap();
let outbox = Iri::try_from("https://dev.example/aviva/treesim/outbox").unwrap();
let followers = Iri::try_from("https://dev.example/aviva/treesim/followers").unwrap();

let key_id = Iri::try_from("https://dev.example/aviva/treesim#main-key").unwrap();
let controller = Iri::try_from("https://dev.example/aviva/treesim").unwrap();
let encoded_multibase = "u7QGwDY2Tjn93PVFWWq02piP1NE9_XRlg-c8-jhJiHqKBHw";

let team = Iri::try_from("https://dev.example/aviva/treesim/team").unwrap();

let json_str = format!(
r#"{{
  "@context": [
    "https://www.w3.org/ns/activitystreams",
    "https://forgefed.org/ns"
  ],
  "type": [
    "Repository",
    "Workflow"
  ],
  "id": "{id}",
  "name": "{name}",
  "summary": "{summary}",
  "inbox": "{inbox}",
  "outbox": "{outbox}",
  "followers": "{followers}",
  "assertionMethod": [
    {{
      "type": "Multikey",
      "id": "{key_id}",
      "controller": "{controller}",
      "publicKeyMultibase": "{encoded_multibase}"
    }}
  ]
}}"#
        );

let context = context::forgefed_context();

let multibase = MultibasePublicKey::new()
    .with_header(MultibaseHeader::Base64UrlNoPad)
    .with_key(MultikeyPublicKey::Ed25519([
        0xb0, 0x0d, 0x8d, 0x93, 0x8e, 0x7f, 0x77, 0x3d, 0x51, 0x56, 0x5a, 0xad, 0x36, 0xa6,
        0x23, 0xf5, 0x34, 0x4f, 0x7f, 0x5d, 0x19, 0x60, 0xf9, 0xcf, 0x3e, 0x8e, 0x12, 0x62,
        0x1e, 0xa2, 0x81, 0x1f,
    ]));

let multikey = Multikey::new_inner()
    .with_id(key_id)
    .with_controller(controller.clone())
    .with_public_key_multibase(multibase);

let repository = Workflow::new()
    .with_context_property(context)
    .with_kind(VocabularyTypes::list([
        ActorType::Repository,
        ActorType::Workflow,
    ]))
    .with_id(id)
    .with_name(name)
    .with_summary(summary)
    .with_inbox(inbox)
    .with_outbox(outbox)
    .with_followers(followers)
    .with_assertion_method([multikey]);

assert_eq!(serde_json::to_string_pretty(&repository).unwrap(), json_str);
assert_eq!(
    serde_json::from_str::<Workflow>(json_str.as_str()).unwrap(),
    repository
);

Implementations

impl<Vocab: ActivityVocabulary + From<ActorType>> Workflow<Vocab>

pub fn new() -> Self

Creates a new Workflow.

pub fn new_inner() -> Self

Creates a new Workflow for use as an inner member of another object.

Encodes the type without the @context field.

pub fn new_kind(kind: Vocab) -> Self

Creates a new Workflow.

pub fn without_context_property(self) -> Self

Builder function that unsets the @context field.

impl<Vocab: ActivityVocabulary> Workflow<Vocab>

pub fn kind(&self) -> &Vocab

Gets the Workflow kind.

Provides the ActivityStream Vocabulary type.

pub fn set_kind<I: Into<Vocab>>(&mut self, val: I)

Sets the Workflow kind.

Provides the ActivityStream Vocabulary type.

pub fn with_kind<I: Into<Vocab>>(self, val: I) -> Self

Builder function that sets the Workflow kind.

Provides the ActivityStream Vocabulary type.

impl<Vocab: ActivityVocabulary> Workflow<Vocab>

pub fn id(&self) -> Option<&Iri>

Gets the Workflow id.

Provides the globally unique identifier for an Object.

pub fn set_id<I: Into<Iri>>(&mut self, val: I)

Sets the Workflow id.

Provides the globally unique identifier for an Object.

pub fn unset_id(&mut self) -> Option<Iri>

Unsets the Workflow id.

Provides the globally unique identifier for an Object.

pub fn with_id<I: Into<Iri>>(self, val: I) -> Self

Builder function that sets the Workflow id.

Provides the globally unique identifier for an Object.

pub fn context_property(&self) -> Option<&Context>

Gets the Workflow context_property.

Represents the special @context property to define the processing context.

The value of the @context property is defined by the JSON-LD specification.

pub fn set_context_property<I: Into<Context>>(&mut self, val: I)

Sets the Workflow context_property.

Represents the special @context property to define the processing context.

The value of the @context property is defined by the JSON-LD specification.

pub fn unset_context_property(&mut self) -> Option<Context>

Unsets the Workflow context_property.

Represents the special @context property to define the processing context.

The value of the @context property is defined by the JSON-LD specification.

pub fn with_context_property<I: Into<Context>>(self, val: I) -> Self

Builder function that sets the Workflow context_property.

Represents the special @context property to define the processing context.

The value of the @context property is defined by the JSON-LD specification.

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

Gets the Workflow name.

A simple, human-readable, plain-text name for the object.

HTML markup MUST NOT be included.

The name MAY be expressed using multiple language-tagged values.

pub fn set_name<I: Into<Name>>(&mut self, val: I)

Sets the Workflow name.

A simple, human-readable, plain-text name for the object.

HTML markup MUST NOT be included.

The name MAY be expressed using multiple language-tagged values.

pub fn unset_name(&mut self) -> Option<Name>

Unsets the Workflow name.

A simple, human-readable, plain-text name for the object.

HTML markup MUST NOT be included.

The name MAY be expressed using multiple language-tagged values.

pub fn with_name<I: Into<Name>>(self, val: I) -> Self

Builder function that sets the Workflow name.

A simple, human-readable, plain-text name for the object.

HTML markup MUST NOT be included.

The name MAY be expressed using multiple language-tagged values.

pub fn name_map(&self) -> Option<&NameMap>

Gets the Workflow name_map.

A simple, human-readable, plain-text name for the object expressed using multiple language-tagged values.

HTML markup MUST NOT be included.

pub fn set_name_map<I: Into<NameMap>>(&mut self, val: I)

Sets the Workflow name_map.

A simple, human-readable, plain-text name for the object expressed using multiple language-tagged values.

HTML markup MUST NOT be included.

pub fn unset_name_map(&mut self) -> Option<NameMap>

Unsets the Workflow name_map.

A simple, human-readable, plain-text name for the object expressed using multiple language-tagged values.

HTML markup MUST NOT be included.

pub fn with_name_map<I: Into<NameMap>>(self, val: I) -> Self

Builder function that sets the Workflow name_map.

A simple, human-readable, plain-text name for the object expressed using multiple language-tagged values.

HTML markup MUST NOT be included.

pub fn content_map(&self) -> Option<&LanguageMap>

Gets the Workflow content_map.

The content or textual representation of the Object encoded as a JSON string, expressed using multiple language-tagged values.

By default, the value of content is HTML.

The mediaType property can be used in the object to indicate a different content type.

pub fn set_content_map<I: Into<LanguageMap>>(&mut self, val: I)

Sets the Workflow content_map.

The content or textual representation of the Object encoded as a JSON string, expressed using multiple language-tagged values.

By default, the value of content is HTML.

The mediaType property can be used in the object to indicate a different content type.

pub fn unset_content_map(&mut self) -> Option<LanguageMap>

Unsets the Workflow content_map.

The content or textual representation of the Object encoded as a JSON string, expressed using multiple language-tagged values.

By default, the value of content is HTML.

The mediaType property can be used in the object to indicate a different content type.

pub fn with_content_map<I: Into<LanguageMap>>(self, val: I) -> Self

Builder function that sets the Workflow content_map.

The content or textual representation of the Object encoded as a JSON string, expressed using multiple language-tagged values.

By default, the value of content is HTML.

The mediaType property can be used in the object to indicate a different content type.

pub fn summary_map(&self) -> Option<&LanguageMap>

Gets the Workflow summary_map.

A natural language summarization of the object encoded as HTML, expressed as multiple language-tagged summaries.

pub fn set_summary_map<I: Into<LanguageMap>>(&mut self, val: I)

Sets the Workflow summary_map.

A natural language summarization of the object encoded as HTML, expressed as multiple language-tagged summaries.

pub fn unset_summary_map(&mut self) -> Option<LanguageMap>

Unsets the Workflow summary_map.

A natural language summarization of the object encoded as HTML, expressed as multiple language-tagged summaries.

pub fn with_summary_map<I: Into<LanguageMap>>(self, val: I) -> Self

Builder function that sets the Workflow summary_map.

A natural language summarization of the object encoded as HTML, expressed as multiple language-tagged summaries.

pub fn duration(&self) -> Option<&Duration>

Gets the Workflow duration.

When the object describes a time-bound resource, such as an audio or video, a meeting, etc, the duration property indicates the object’s approximate duration.

The value MUST be expressed as an xsd:duration as defined by xmlschema11-2.

pub fn set_duration<I: Into<Duration>>(&mut self, val: I)

Sets the Workflow duration.

When the object describes a time-bound resource, such as an audio or video, a meeting, etc, the duration property indicates the object’s approximate duration.

The value MUST be expressed as an xsd:duration as defined by xmlschema11-2.

pub fn unset_duration(&mut self) -> Option<Duration>

Unsets the Workflow duration.

When the object describes a time-bound resource, such as an audio or video, a meeting, etc, the duration property indicates the object’s approximate duration.

The value MUST be expressed as an xsd:duration as defined by xmlschema11-2.

pub fn with_duration<I: Into<Duration>>(self, val: I) -> Self

Builder function that sets the Workflow duration.

When the object describes a time-bound resource, such as an audio or video, a meeting, etc, the duration property indicates the object’s approximate duration.

The value MUST be expressed as an xsd:duration as defined by xmlschema11-2.

pub fn source(&self) -> Option<&ContentItem>

Gets the Workflow source.

Represents the source of the content field.

pub fn set_source<I: Into<ContentItem>>(&mut self, val: I)

Sets the Workflow source.

Represents the source of the content field.

pub fn unset_source(&mut self) -> Option<ContentItem>

Unsets the Workflow source.

Represents the source of the content field.

pub fn with_source<I: Into<ContentItem>>(self, val: I) -> Self

Builder function that sets the Workflow source.

Represents the source of the content field.

pub fn proof(&self) -> Option<&DataIntegrityProof>

Gets the Workflow proof.

Represents a DataIntegrityProof.

pub fn set_proof<I: Into<DataIntegrityProof>>(&mut self, val: I)

Sets the Workflow proof.

Represents a DataIntegrityProof.

pub fn unset_proof(&mut self) -> Option<DataIntegrityProof>

Unsets the Workflow proof.

Represents a DataIntegrityProof.

pub fn with_proof<I: Into<DataIntegrityProof>>(self, val: I) -> Self

Builder function that sets the Workflow proof.

Represents a DataIntegrityProof.

pub fn url(&self) -> Option<&LinkItems>

Gets the Workflow url.

Identifies one or more links to representations of the object

pub fn set_url<I: Into<LinkItems>>(&mut self, val: I)

Sets the Workflow url.

Identifies one or more links to representations of the object

pub fn unset_url(&mut self) -> Option<LinkItems>

Unsets the Workflow url.

Identifies one or more links to representations of the object

pub fn with_url<I: Into<LinkItems>>(self, val: I) -> Self

Builder function that sets the Workflow url.

Identifies one or more links to representations of the object

impl<Vocab: ActivityVocabulary> Workflow<Vocab>

pub fn content(&self) -> Option<&str>

Gets the Workflow content.

The content or textual representation of the Object encoded as a JSON string.

By default, the value of content is HTML.

The mediaType property can be used in the object to indicate a different content type.

The content MAY be expressed using multiple language-tagged values.

pub fn set_content<I: Into<String>>(&mut self, val: I)

Sets the Workflow content.

The content or textual representation of the Object encoded as a JSON string.

By default, the value of content is HTML.

The mediaType property can be used in the object to indicate a different content type.

The content MAY be expressed using multiple language-tagged values.

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

Unsets the Workflow content.

The content or textual representation of the Object encoded as a JSON string.

By default, the value of content is HTML.

The mediaType property can be used in the object to indicate a different content type.

The content MAY be expressed using multiple language-tagged values.

pub fn with_content<I: Into<String>>(self, val: I) -> Self

Builder function that sets the Workflow content.

The content or textual representation of the Object encoded as a JSON string.

By default, the value of content is HTML.

The mediaType property can be used in the object to indicate a different content type.

The content MAY be expressed using multiple language-tagged values.

pub fn summary(&self) -> Option<&str>

Gets the Workflow summary.

A natural language summarization of the object encoded as HTML.

Multiple language tagged summaries MAY be provided.

pub fn set_summary<I: Into<String>>(&mut self, val: I)

Sets the Workflow summary.

A natural language summarization of the object encoded as HTML.

Multiple language tagged summaries MAY be provided.

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

Unsets the Workflow summary.

A natural language summarization of the object encoded as HTML.

Multiple language tagged summaries MAY be provided.

pub fn with_summary<I: Into<String>>(self, val: I) -> Self

Builder function that sets the Workflow summary.

A natural language summarization of the object encoded as HTML.

Multiple language tagged summaries MAY be provided.

impl<Vocab: ActivityVocabulary> Workflow<Vocab>

pub fn attachment(&self) -> Option<&Items>

Gets the Workflow attachment.

Identifies a resource attached or related to an object that potentially requires special handling.

The intent is to provide a model that is at least semantically similar to attachments in email.

pub fn set_attachment<I: Into<Items>>(&mut self, val: I)

Sets the Workflow attachment.

Identifies a resource attached or related to an object that potentially requires special handling.

The intent is to provide a model that is at least semantically similar to attachments in email.

pub fn unset_attachment(&mut self) -> Option<Box<Items>>

Unsets the Workflow attachment.

Identifies a resource attached or related to an object that potentially requires special handling.

The intent is to provide a model that is at least semantically similar to attachments in email.

pub fn with_attachment<I: Into<Items>>(self, val: I) -> Self

Builder function that sets the Workflow attachment.

Identifies a resource attached or related to an object that potentially requires special handling.

The intent is to provide a model that is at least semantically similar to attachments in email.

pub fn attributed_to(&self) -> Option<&Item>

Gets the Workflow attributed_to.

Identifies one or more entities to which this object is attributed.

The attributed entities might not be Actors.

For instance, an object might be attributed to the completion of another activity.

pub fn set_attributed_to<I: Into<Item>>(&mut self, val: I)

Sets the Workflow attributed_to.

Identifies one or more entities to which this object is attributed.

The attributed entities might not be Actors.

For instance, an object might be attributed to the completion of another activity.

pub fn unset_attributed_to(&mut self) -> Option<Box<Item>>

Unsets the Workflow attributed_to.

Identifies one or more entities to which this object is attributed.

The attributed entities might not be Actors.

For instance, an object might be attributed to the completion of another activity.

pub fn with_attributed_to<I: Into<Item>>(self, val: I) -> Self

Builder function that sets the Workflow attributed_to.

Identifies one or more entities to which this object is attributed.

The attributed entities might not be Actors.

For instance, an object might be attributed to the completion of another activity.

pub fn audience(&self) -> Option<&Item>

Gets the Workflow audience.

Identifies one or more entities that represent the total population of entities for which the object can be considered to be relevant.

pub fn set_audience<I: Into<Item>>(&mut self, val: I)

Sets the Workflow audience.

Identifies one or more entities that represent the total population of entities for which the object can be considered to be relevant.

pub fn unset_audience(&mut self) -> Option<Box<Item>>

Unsets the Workflow audience.

Identifies one or more entities that represent the total population of entities for which the object can be considered to be relevant.

pub fn with_audience<I: Into<Item>>(self, val: I) -> Self

Builder function that sets the Workflow audience.

Identifies one or more entities that represent the total population of entities for which the object can be considered to be relevant.

pub fn context(&self) -> Option<&Item>

Gets the Workflow context.

Identifies the context within which the object exists or an activity was performed.

The notion of “context” used is intentionally vague.

The intended function is to serve as a means of grouping objects and activities that share a common originating context or purpose.

An example could be all activities relating to a common project or event.

pub fn set_context<I: Into<Item>>(&mut self, val: I)

Sets the Workflow context.

Identifies the context within which the object exists or an activity was performed.

The notion of “context” used is intentionally vague.

The intended function is to serve as a means of grouping objects and activities that share a common originating context or purpose.

An example could be all activities relating to a common project or event.

pub fn unset_context(&mut self) -> Option<Box<Item>>

Unsets the Workflow context.

Identifies the context within which the object exists or an activity was performed.

The notion of “context” used is intentionally vague.

The intended function is to serve as a means of grouping objects and activities that share a common originating context or purpose.

An example could be all activities relating to a common project or event.

pub fn with_context<I: Into<Item>>(self, val: I) -> Self

Builder function that sets the Workflow context.

Identifies the context within which the object exists or an activity was performed.

The notion of “context” used is intentionally vague.

The intended function is to serve as a means of grouping objects and activities that share a common originating context or purpose.

An example could be all activities relating to a common project or event.

pub fn generator(&self) -> Option<&Item>

Gets the Workflow generator.

Identifies the entity (e.g. an application) that generated the object.

pub fn set_generator<I: Into<Item>>(&mut self, val: I)

Sets the Workflow generator.

Identifies the entity (e.g. an application) that generated the object.

pub fn unset_generator(&mut self) -> Option<Box<Item>>

Unsets the Workflow generator.

Identifies the entity (e.g. an application) that generated the object.

pub fn with_generator<I: Into<Item>>(self, val: I) -> Self

Builder function that sets the Workflow generator.

Identifies the entity (e.g. an application) that generated the object.

pub fn icon(&self) -> Option<&ImageItem>

Gets the Workflow icon.

Indicates an entity that describes an icon for this object.

The image should have an aspect ratio of one (horizontal) to one (vertical) and should be suitable for presentation at a small size.

pub fn set_icon<I: Into<ImageItem>>(&mut self, val: I)

Sets the Workflow icon.

Indicates an entity that describes an icon for this object.

The image should have an aspect ratio of one (horizontal) to one (vertical) and should be suitable for presentation at a small size.

pub fn unset_icon(&mut self) -> Option<Box<ImageItem>>

Unsets the Workflow icon.

Indicates an entity that describes an icon for this object.

The image should have an aspect ratio of one (horizontal) to one (vertical) and should be suitable for presentation at a small size.

pub fn with_icon<I: Into<ImageItem>>(self, val: I) -> Self

Builder function that sets the Workflow icon.

Indicates an entity that describes an icon for this object.

The image should have an aspect ratio of one (horizontal) to one (vertical) and should be suitable for presentation at a small size.

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

Gets the Workflow image.

Indicates an entity that describes an image for this object.

Unlike the icon property, there are no aspect ratio or display size limitations assumed.

pub fn set_image<I: Into<ImageItem>>(&mut self, val: I)

Sets the Workflow image.

Indicates an entity that describes an image for this object.

Unlike the icon property, there are no aspect ratio or display size limitations assumed.

pub fn unset_image(&mut self) -> Option<Box<ImageItem>>

Unsets the Workflow image.

Indicates an entity that describes an image for this object.

Unlike the icon property, there are no aspect ratio or display size limitations assumed.

pub fn with_image<I: Into<ImageItem>>(self, val: I) -> Self

Builder function that sets the Workflow image.

Indicates an entity that describes an image for this object.

Unlike the icon property, there are no aspect ratio or display size limitations assumed.

pub fn in_reply_to(&self) -> Option<&Item>

Gets the Workflow in_reply_to.

Indicates one or more entities for which this object is considered a response.

pub fn set_in_reply_to<I: Into<Item>>(&mut self, val: I)

Sets the Workflow in_reply_to.

Indicates one or more entities for which this object is considered a response.

pub fn unset_in_reply_to(&mut self) -> Option<Box<Item>>

Unsets the Workflow in_reply_to.

Indicates one or more entities for which this object is considered a response.

pub fn with_in_reply_to<I: Into<Item>>(self, val: I) -> Self

Builder function that sets the Workflow in_reply_to.

Indicates one or more entities for which this object is considered a response.

pub fn location(&self) -> Option<&Item>

Gets the Workflow location.

Indicates one or more physical or logical locations associated with the object.

pub fn set_location<I: Into<Item>>(&mut self, val: I)

Sets the Workflow location.

Indicates one or more physical or logical locations associated with the object.

pub fn unset_location(&mut self) -> Option<Box<Item>>

Unsets the Workflow location.

Indicates one or more physical or logical locations associated with the object.

pub fn with_location<I: Into<Item>>(self, val: I) -> Self

Builder function that sets the Workflow location.

Indicates one or more physical or logical locations associated with the object.

pub fn preview(&self) -> Option<&Item>

Gets the Workflow preview.

Identifies an entity that provides a preview of this object.

pub fn set_preview<I: Into<Item>>(&mut self, val: I)

Sets the Workflow preview.

Identifies an entity that provides a preview of this object.

pub fn unset_preview(&mut self) -> Option<Box<Item>>

Unsets the Workflow preview.

Identifies an entity that provides a preview of this object.

pub fn with_preview<I: Into<Item>>(self, val: I) -> Self

Builder function that sets the Workflow preview.

Identifies an entity that provides a preview of this object.

pub fn replies(&self) -> Option<&Collection>

Gets the Workflow replies.

Identifies a Collection containing objects considered to be responses to this object.

pub fn set_replies<I: Into<Collection>>(&mut self, val: I)

Sets the Workflow replies.

Identifies a Collection containing objects considered to be responses to this object.

pub fn unset_replies(&mut self) -> Option<Box<Collection>>

Unsets the Workflow replies.

Identifies a Collection containing objects considered to be responses to this object.

pub fn with_replies<I: Into<Collection>>(self, val: I) -> Self

Builder function that sets the Workflow replies.

Identifies a Collection containing objects considered to be responses to this object.

pub fn tag(&self) -> Option<&Items>

Gets the Workflow tag.

One or more “tags” that have been associated with an objects.

A tag can be any kind of Object.

The key difference between attachment and tag is that the former implies association by inclusion,

while the latter implies associated by reference.

pub fn set_tag<I: Into<Items>>(&mut self, val: I)

Sets the Workflow tag.

One or more “tags” that have been associated with an objects.

A tag can be any kind of Object.

The key difference between attachment and tag is that the former implies association by inclusion,

while the latter implies associated by reference.

pub fn unset_tag(&mut self) -> Option<Box<Items>>

Unsets the Workflow tag.

One or more “tags” that have been associated with an objects.

A tag can be any kind of Object.

The key difference between attachment and tag is that the former implies association by inclusion,

while the latter implies associated by reference.

pub fn with_tag<I: Into<Items>>(self, val: I) -> Self

Builder function that sets the Workflow tag.

One or more “tags” that have been associated with an objects.

A tag can be any kind of Object.

The key difference between attachment and tag is that the former implies association by inclusion,

while the latter implies associated by reference.

pub fn to(&self) -> Option<&Items>

Gets the Workflow to.

Identifies one or more entities that are part of the public primary audience of this Object.

pub fn set_to<I: Into<Items>>(&mut self, val: I)

Sets the Workflow to.

Identifies one or more entities that are part of the public primary audience of this Object.

pub fn unset_to(&mut self) -> Option<Box<Items>>

Unsets the Workflow to.

Identifies one or more entities that are part of the public primary audience of this Object.

pub fn with_to<I: Into<Items>>(self, val: I) -> Self

Builder function that sets the Workflow to.

Identifies one or more entities that are part of the public primary audience of this Object.

pub fn bto(&self) -> Option<&Items>

Gets the Workflow bto.

Identifies one or more entities that are part of the private primary audience of this Object.

pub fn set_bto<I: Into<Items>>(&mut self, val: I)

Sets the Workflow bto.

Identifies one or more entities that are part of the private primary audience of this Object.

pub fn unset_bto(&mut self) -> Option<Box<Items>>

Unsets the Workflow bto.

Identifies one or more entities that are part of the private primary audience of this Object.

pub fn with_bto<I: Into<Items>>(self, val: I) -> Self

Builder function that sets the Workflow bto.

Identifies one or more entities that are part of the private primary audience of this Object.

pub fn cc(&self) -> Option<&Items>

Gets the Workflow cc.

Identifies one or more entities that are part of the public secondary audience of this Object.

pub fn set_cc<I: Into<Items>>(&mut self, val: I)

Sets the Workflow cc.

Identifies one or more entities that are part of the public secondary audience of this Object.

pub fn unset_cc(&mut self) -> Option<Box<Items>>

Unsets the Workflow cc.

Identifies one or more entities that are part of the public secondary audience of this Object.

pub fn with_cc<I: Into<Items>>(self, val: I) -> Self

Builder function that sets the Workflow cc.

Identifies one or more entities that are part of the public secondary audience of this Object.

pub fn bcc(&self) -> Option<&Items>

Gets the Workflow bcc.

Identifies one or more entities that are part of the private secondary audience of this Object.

pub fn set_bcc<I: Into<Items>>(&mut self, val: I)

Sets the Workflow bcc.

Identifies one or more entities that are part of the private secondary audience of this Object.

pub fn unset_bcc(&mut self) -> Option<Box<Items>>

Unsets the Workflow bcc.

Identifies one or more entities that are part of the private secondary audience of this Object.

pub fn with_bcc<I: Into<Items>>(self, val: I) -> Self

Builder function that sets the Workflow bcc.

Identifies one or more entities that are part of the private secondary audience of this Object.

pub fn extra_fields(&self) -> Option<&Map<String, Value>>

Gets the Workflow extra_fields.

pub fn set_extra_fields<I: Into<Map<String, Value>>>(&mut self, val: I)

Sets the Workflow extra_fields.

pub fn unset_extra_fields(&mut self) -> Option<Box<Map<String, Value>>>

Unsets the Workflow extra_fields.

pub fn with_extra_fields<I: Into<Map<String, Value>>>(self, val: I) -> Self

Builder function that sets the Workflow extra_fields.

impl<Vocab: ActivityVocabulary> Workflow<Vocab>

pub const fn media_type(&self) -> Option<MimeType>

Gets the Workflow media_type.

When used on a Link, identifies the MIME media type of the referenced resource.

When used on an Object, identifies the MIME media type of the value of the content property.

If not specified, the content property is assumed to contain text/html content.

pub fn set_media_type<I: Into<MimeType>>(&mut self, val: I)

Sets the Workflow media_type.

When used on a Link, identifies the MIME media type of the referenced resource.

When used on an Object, identifies the MIME media type of the value of the content property.

If not specified, the content property is assumed to contain text/html content.

pub fn unset_media_type(&mut self) -> Option<MimeType>

Unsets the Workflow media_type.

When used on a Link, identifies the MIME media type of the referenced resource.

When used on an Object, identifies the MIME media type of the value of the content property.

If not specified, the content property is assumed to contain text/html content.

pub fn with_media_type<I: Into<MimeType>>(self, val: I) -> Self

Builder function that sets the Workflow media_type.

When used on a Link, identifies the MIME media type of the referenced resource.

When used on an Object, identifies the MIME media type of the value of the content property.

If not specified, the content property is assumed to contain text/html content.

pub const fn start_time(&self) -> Option<DateTime>

Gets the Workflow start_time.

The date and time describing the actual or expected starting time of the object.

When used with an Activity object, for instance, the startTime property specifies the moment the activity began or is scheduled to begin.

pub fn set_start_time<I: Into<DateTime>>(&mut self, val: I)

Sets the Workflow start_time.

The date and time describing the actual or expected starting time of the object.

When used with an Activity object, for instance, the startTime property specifies the moment the activity began or is scheduled to begin.

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

Unsets the Workflow start_time.

The date and time describing the actual or expected starting time of the object.

When used with an Activity object, for instance, the startTime property specifies the moment the activity began or is scheduled to begin.

pub fn with_start_time<I: Into<DateTime>>(self, val: I) -> Self

Builder function that sets the Workflow start_time.

The date and time describing the actual or expected starting time of the object.

When used with an Activity object, for instance, the startTime property specifies the moment the activity began or is scheduled to begin.

pub const fn end_time(&self) -> Option<DateTime>

Gets the Workflow end_time.

The date and time describing the actual or expected ending time of the object.

When used with an Activity object, for instance, the endTime property specifies the moment the activity concluded or is expected to conclude.

pub fn set_end_time<I: Into<DateTime>>(&mut self, val: I)

Sets the Workflow end_time.

The date and time describing the actual or expected ending time of the object.

When used with an Activity object, for instance, the endTime property specifies the moment the activity concluded or is expected to conclude.

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

Unsets the Workflow end_time.

The date and time describing the actual or expected ending time of the object.

When used with an Activity object, for instance, the endTime property specifies the moment the activity concluded or is expected to conclude.

pub fn with_end_time<I: Into<DateTime>>(self, val: I) -> Self

Builder function that sets the Workflow end_time.

The date and time describing the actual or expected ending time of the object.

When used with an Activity object, for instance, the endTime property specifies the moment the activity concluded or is expected to conclude.

pub const fn published(&self) -> Option<DateTime>

Gets the Workflow published.

The date and time at which the object was published.

pub fn set_published<I: Into<DateTime>>(&mut self, val: I)

Sets the Workflow published.

The date and time at which the object was published.

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

Unsets the Workflow published.

The date and time at which the object was published.

pub fn with_published<I: Into<DateTime>>(self, val: I) -> Self

Builder function that sets the Workflow published.

The date and time at which the object was published.

pub const fn updated(&self) -> Option<DateTime>

Gets the Workflow updated.

The date and time at which the object was updated.

pub fn set_updated<I: Into<DateTime>>(&mut self, val: I)

Sets the Workflow updated.

The date and time at which the object was updated.

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

Unsets the Workflow updated.

The date and time at which the object was updated.

pub fn with_updated<I: Into<DateTime>>(self, val: I) -> Self

Builder function that sets the Workflow updated.

The date and time at which the object was updated.

impl<Vocab: ActivityVocabulary> Workflow<Vocab>

pub fn inbox(&self) -> Option<&Item>

Gets the Workflow inbox.

A reference to an ActivityStreams OrderedCollection comprised of all the messages received by the actor; see 5.2 Inbox.

pub fn set_inbox<I: Into<Item>>(&mut self, val: I)

Sets the Workflow inbox.

A reference to an ActivityStreams OrderedCollection comprised of all the messages received by the actor; see 5.2 Inbox.

pub fn unset_inbox(&mut self) -> Option<Item>

Unsets the Workflow inbox.

A reference to an ActivityStreams OrderedCollection comprised of all the messages received by the actor; see 5.2 Inbox.

pub fn with_inbox<I: Into<Item>>(self, val: I) -> Self

Builder function that sets the Workflow inbox.

A reference to an ActivityStreams OrderedCollection comprised of all the messages received by the actor; see 5.2 Inbox.

pub fn outbox(&self) -> Option<&Item>

Gets the Workflow outbox.

An ActivityStreams OrderedCollection comprised of all the messages produced by the actor; see 5.1 Outbox.

pub fn set_outbox<I: Into<Item>>(&mut self, val: I)

Sets the Workflow outbox.

An ActivityStreams OrderedCollection comprised of all the messages produced by the actor; see 5.1 Outbox.

pub fn unset_outbox(&mut self) -> Option<Item>

Unsets the Workflow outbox.

An ActivityStreams OrderedCollection comprised of all the messages produced by the actor; see 5.1 Outbox.

pub fn with_outbox<I: Into<Item>>(self, val: I) -> Self

Builder function that sets the Workflow outbox.

An ActivityStreams OrderedCollection comprised of all the messages produced by the actor; see 5.1 Outbox.

pub fn following(&self) -> Option<&Item>

Gets the Workflow following.

A link to an ActivityStreams collection of the actors that this actor is following; see 5.4 Following Collection.

pub fn set_following<I: Into<Item>>(&mut self, val: I)

Sets the Workflow following.

A link to an ActivityStreams collection of the actors that this actor is following; see 5.4 Following Collection.

pub fn unset_following(&mut self) -> Option<Item>

Unsets the Workflow following.

A link to an ActivityStreams collection of the actors that this actor is following; see 5.4 Following Collection.

pub fn with_following<I: Into<Item>>(self, val: I) -> Self

Builder function that sets the Workflow following.

A link to an ActivityStreams collection of the actors that this actor is following; see 5.4 Following Collection.

pub fn followers(&self) -> Option<&Item>

Gets the Workflow followers.

A link to an ActivityStreams collection of the actors that follow this actor; see 5.3 Followers Collection.

pub fn set_followers<I: Into<Item>>(&mut self, val: I)

Sets the Workflow followers.

A link to an ActivityStreams collection of the actors that follow this actor; see 5.3 Followers Collection.

pub fn unset_followers(&mut self) -> Option<Item>

Unsets the Workflow followers.

A link to an ActivityStreams collection of the actors that follow this actor; see 5.3 Followers Collection.

pub fn with_followers<I: Into<Item>>(self, val: I) -> Self

Builder function that sets the Workflow followers.

A link to an ActivityStreams collection of the actors that follow this actor; see 5.3 Followers Collection.

pub fn liked(&self) -> Option<&Item>

Gets the Workflow liked.

A link to an ActivityStreams collection of objects this actor has liked; see 5.5 Liked Collection.

pub fn set_liked<I: Into<Item>>(&mut self, val: I)

Sets the Workflow liked.

A link to an ActivityStreams collection of objects this actor has liked; see 5.5 Liked Collection.

pub fn unset_liked(&mut self) -> Option<Item>

Unsets the Workflow liked.

A link to an ActivityStreams collection of objects this actor has liked; see 5.5 Liked Collection.

pub fn with_liked<I: Into<Item>>(self, val: I) -> Self

Builder function that sets the Workflow liked.

A link to an ActivityStreams collection of objects this actor has liked; see 5.5 Liked Collection.

pub fn streams(&self) -> Option<&Items>

Gets the Workflow streams.

A list of supplementary Collections which may be of interest.

pub fn set_streams<I: Into<Items>>(&mut self, val: I)

Sets the Workflow streams.

A list of supplementary Collections which may be of interest.

pub fn unset_streams(&mut self) -> Option<Items>

Unsets the Workflow streams.

A list of supplementary Collections which may be of interest.

pub fn with_streams<I: Into<Items>>(self, val: I) -> Self

Builder function that sets the Workflow streams.

A list of supplementary Collections which may be of interest.

pub fn preferred_username(&self) -> Option<&Name>

Gets the Workflow preferred_username.

A short username which may be used to refer to the actor, with no uniqueness guarantees.

pub fn set_preferred_username<I: Into<Name>>(&mut self, val: I)

Sets the Workflow preferred_username.

A short username which may be used to refer to the actor, with no uniqueness guarantees.

pub fn unset_preferred_username(&mut self) -> Option<Name>

Unsets the Workflow preferred_username.

A short username which may be used to refer to the actor, with no uniqueness guarantees.

pub fn with_preferred_username<I: Into<Name>>(self, val: I) -> Self

Builder function that sets the Workflow preferred_username.

A short username which may be used to refer to the actor, with no uniqueness guarantees.

pub fn endpoints(&self) -> Option<&Endpoints>

Gets the Workflow endpoints.

A json object which maps additional (typically server/domain-wide) endpoints which may be useful either for this actor or someone referencing this actor.

This mapping may be nested inside the actor document as the value or may be a link to a JSON-LD document with these properties.

pub fn set_endpoints<I: Into<Endpoints>>(&mut self, val: I)

Sets the Workflow endpoints.

A json object which maps additional (typically server/domain-wide) endpoints which may be useful either for this actor or someone referencing this actor.

This mapping may be nested inside the actor document as the value or may be a link to a JSON-LD document with these properties.

pub fn unset_endpoints(&mut self) -> Option<Endpoints>

Unsets the Workflow endpoints.

A json object which maps additional (typically server/domain-wide) endpoints which may be useful either for this actor or someone referencing this actor.

This mapping may be nested inside the actor document as the value or may be a link to a JSON-LD document with these properties.

pub fn with_endpoints<I: Into<Endpoints>>(self, val: I) -> Self

Builder function that sets the Workflow endpoints.

A json object which maps additional (typically server/domain-wide) endpoints which may be useful either for this actor or someone referencing this actor.

This mapping may be nested inside the actor document as the value or may be a link to a JSON-LD document with these properties.

pub fn assertion_method(&self) -> Option<&MultikeyItems>

Gets the Workflow assertion_method.

A list of public key representations following the FEP-521a specification.

pub fn set_assertion_method<I: Into<MultikeyItems>>(&mut self, val: I)

Sets the Workflow assertion_method.

A list of public key representations following the FEP-521a specification.

pub fn unset_assertion_method(&mut self) -> Option<MultikeyItems>

Unsets the Workflow assertion_method.

A list of public key representations following the FEP-521a specification.

pub fn with_assertion_method<I: Into<MultikeyItems>>(self, val: I) -> Self

Builder function that sets the Workflow assertion_method.

A list of public key representations following the FEP-521a specification.

pub fn public_key(&self) -> Option<&KeyItems>

👎Deprecated since 0.3.0:

The publicKey vocabulary has been deprecated since Security Vocabulary 2.0. Users should use the assertionMethod field instead, where possible.

Gets the Workflow public_key.

Public key used for HTTP Signatures and Linked Data Signatures.

pub fn set_public_key<I: Into<KeyItems>>(&mut self, val: I)

👎Deprecated since 0.3.0:

The publicKey vocabulary has been deprecated since Security Vocabulary 2.0. Users should use the assertionMethod field instead, where possible.

Sets the Workflow public_key.

Public key used for HTTP Signatures and Linked Data Signatures.

pub fn unset_public_key(&mut self) -> Option<KeyItems>

👎Deprecated since 0.3.0:

The publicKey vocabulary has been deprecated since Security Vocabulary 2.0. Users should use the assertionMethod field instead, where possible.

Unsets the Workflow public_key.

Public key used for HTTP Signatures and Linked Data Signatures.

pub fn with_public_key<I: Into<KeyItems>>(self, val: I) -> Self

👎Deprecated since 0.3.0:

The publicKey vocabulary has been deprecated since Security Vocabulary 2.0. Users should use the assertionMethod field instead, where possible.

Builder function that sets the Workflow public_key.

Public key used for HTTP Signatures and Linked Data Signatures.

Trait Implementations

impl<Vocab: Clone + ActivityVocabulary> Clone for Workflow<Vocab>

fn clone(&self) -> Workflow<Vocab>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<Vocab: Debug + ActivityVocabulary> Debug for Workflow<Vocab>

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

Formats the value using the given formatter.

impl Default for Workflow

fn default() -> Self

Returns the “default value” for a type.

impl<'de, T: ActivityVocabulary> Deserialize<'de> for Workflow<T>

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Workflow

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

Formats the value using the given formatter.

impl From<Workflow> for Item

fn from(val: Workflow) -> Self

Converts to this type from the input type.

impl From<Workflow> for Object<VocabularyTypes>

fn from(val: Workflow<VocabularyTypes>) -> Self

Converts to this type from the input type.

impl From<Workflow> for Option<Box<Item>>

fn from(val: Workflow) -> Self

Converts to this type from the input type.

impl From<Workflow> for Option<Box<Items>>

fn from(val: Workflow) -> Self

Converts to this type from the input type.

impl From<Workflow> for Option<Box<OrderedItems>>

fn from(val: Workflow) -> Self

Converts to this type from the input type.

impl<Vocab: PartialEq + ActivityVocabulary> PartialEq for Workflow<Vocab>

fn eq(&self, other: &Workflow<Vocab>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<Vocab: ActivityVocabulary> Serialize for Workflow<Vocab>

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<Vocab: Eq + ActivityVocabulary> Eq for Workflow<Vocab>

impl<Vocab: ActivityVocabulary> StructuralPartialEq for Workflow<Vocab>