Skip to main content

DocumentationBuilder

ftm_types::generated::entities

Struct DocumentationBuilder 

Source 
pub struct DocumentationBuilder<S: State = Empty> { /* private fields */ }
Expand description

Use builder syntax to set the inputs and finish with build().

Implementations§

Source§

impl<S: State> DocumentationBuilder<S>

Source

pub fn build(self) -> Documentation
where S: IsComplete,

Finish building and return the requested object

Source

pub fn id(self, value: String) -> DocumentationBuilder<SetId<S>>
where S::Id: IsUnset,

Required.

Source

pub fn schema(self, value: String) -> DocumentationBuilder<SetSchema<S>>
where S::Schema: IsUnset,

Optional (Some / Option setters). Default: "Documentation".to_string().

Source

pub fn maybe_schema( self, value: Option<String>, ) -> DocumentationBuilder<SetSchema<S>>
where S::Schema: IsUnset,

Optional (Some / Option setters). Default: "Documentation".to_string().

Source

pub fn aleph_url( self, value: impl Into<String>, ) -> DocumentationBuilder<SetAlephUrl<S>>
where S::AlephUrl: IsUnset,

Optional (Some / Option setters). Property: Aleph URL

Source

pub fn maybe_aleph_url( self, value: Option<impl Into<String>>, ) -> DocumentationBuilder<SetAlephUrl<S>>
where S::AlephUrl: IsUnset,

Optional (Some / Option setters). Property: Aleph URL

Source

pub fn date(self, value: impl Into<String>) -> DocumentationBuilder<SetDate<S>>
where S::Date: IsUnset,

Optional (Some / Option setters). Property: Date

Source

pub fn maybe_date( self, value: Option<impl Into<String>>, ) -> DocumentationBuilder<SetDate<S>>
where S::Date: IsUnset,

Optional (Some / Option setters). Property: Date

Source

pub fn description( self, value: impl Into<String>, ) -> DocumentationBuilder<SetDescription<S>>
where S::Description: IsUnset,

Optional (Some / Option setters). Property: Description

Source

pub fn maybe_description( self, value: Option<impl Into<String>>, ) -> DocumentationBuilder<SetDescription<S>>
where S::Description: IsUnset,

Optional (Some / Option setters). Property: Description

Source

pub fn document( self, value: impl Into<String>, ) -> DocumentationBuilder<SetDocument<S>>
where S::Document: IsUnset,

Required.

Property: Document

Source

pub fn end_date( self, value: impl Into<String>, ) -> DocumentationBuilder<SetEndDate<S>>
where S::EndDate: IsUnset,

Optional (Some / Option setters). Property: End date

Source

pub fn maybe_end_date( self, value: Option<impl Into<String>>, ) -> DocumentationBuilder<SetEndDate<S>>
where S::EndDate: IsUnset,

Optional (Some / Option setters). Property: End date

Source

pub fn entity( self, value: impl Into<String>, ) -> DocumentationBuilder<SetEntity<S>>
where S::Entity: IsUnset,

Required.

Property: Entity

Source

pub fn index_text( self, value: impl Into<String>, ) -> DocumentationBuilder<SetIndexText<S>>
where S::IndexText: IsUnset,

Optional (Some / Option setters). Property: Index text

Source

pub fn maybe_index_text( self, value: Option<impl Into<String>>, ) -> DocumentationBuilder<SetIndexText<S>>
where S::IndexText: IsUnset,

Optional (Some / Option setters). Property: Index text

Source

pub fn modified_at( self, value: impl Into<String>, ) -> DocumentationBuilder<SetModifiedAt<S>>
where S::ModifiedAt: IsUnset,

Optional (Some / Option setters). Property: Modified on

Source

pub fn maybe_modified_at( self, value: Option<impl Into<String>>, ) -> DocumentationBuilder<SetModifiedAt<S>>
where S::ModifiedAt: IsUnset,

Optional (Some / Option setters). Property: Modified on

Source

pub fn names_mentioned( self, value: impl Into<String>, ) -> DocumentationBuilder<SetNamesMentioned<S>>
where S::NamesMentioned: IsUnset,

Optional (Some / Option setters). Property: Detected names

Source

pub fn maybe_names_mentioned( self, value: Option<impl Into<String>>, ) -> DocumentationBuilder<SetNamesMentioned<S>>
where S::NamesMentioned: IsUnset,

Optional (Some / Option setters). Property: Detected names

Source

pub fn proof( self, value: impl Into<String>, ) -> DocumentationBuilder<SetProof<S>>
where S::Proof: IsUnset,

Optional (Some / Option setters). Property: Source document

Source

pub fn maybe_proof( self, value: Option<impl Into<String>>, ) -> DocumentationBuilder<SetProof<S>>
where S::Proof: IsUnset,

Optional (Some / Option setters). Property: Source document

Source

pub fn publisher( self, value: impl Into<String>, ) -> DocumentationBuilder<SetPublisher<S>>
where S::Publisher: IsUnset,

Optional (Some / Option setters). Property: Publishing source

Source

pub fn maybe_publisher( self, value: Option<impl Into<String>>, ) -> DocumentationBuilder<SetPublisher<S>>
where S::Publisher: IsUnset,

Optional (Some / Option setters). Property: Publishing source

Source

pub fn publisher_url( self, value: impl Into<String>, ) -> DocumentationBuilder<SetPublisherUrl<S>>
where S::PublisherUrl: IsUnset,

Optional (Some / Option setters). Property: Publishing source URL

Source

pub fn maybe_publisher_url( self, value: Option<impl Into<String>>, ) -> DocumentationBuilder<SetPublisherUrl<S>>
where S::PublisherUrl: IsUnset,

Optional (Some / Option setters). Property: Publishing source URL

Source

pub fn record_id( self, value: impl Into<String>, ) -> DocumentationBuilder<SetRecordId<S>>
where S::RecordId: IsUnset,

Optional (Some / Option setters). Property: Record ID

Source

pub fn maybe_record_id( self, value: Option<impl Into<String>>, ) -> DocumentationBuilder<SetRecordId<S>>
where S::RecordId: IsUnset,

Optional (Some / Option setters). Property: Record ID

Source

pub fn retrieved_at( self, value: impl Into<String>, ) -> DocumentationBuilder<SetRetrievedAt<S>>
where S::RetrievedAt: IsUnset,

Optional (Some / Option setters). Property: Retrieved on

Source

pub fn maybe_retrieved_at( self, value: Option<impl Into<String>>, ) -> DocumentationBuilder<SetRetrievedAt<S>>
where S::RetrievedAt: IsUnset,

Optional (Some / Option setters). Property: Retrieved on

Source

pub fn role(self, value: impl Into<String>) -> DocumentationBuilder<SetRole<S>>
where S::Role: IsUnset,

Optional (Some / Option setters). Property: Role

Source

pub fn maybe_role( self, value: Option<impl Into<String>>, ) -> DocumentationBuilder<SetRole<S>>
where S::Role: IsUnset,

Optional (Some / Option setters). Property: Role

Source

pub fn source_url( self, value: impl Into<String>, ) -> DocumentationBuilder<SetSourceUrl<S>>
where S::SourceUrl: IsUnset,

Optional (Some / Option setters). Property: Source link

Source

pub fn maybe_source_url( self, value: Option<impl Into<String>>, ) -> DocumentationBuilder<SetSourceUrl<S>>
where S::SourceUrl: IsUnset,

Optional (Some / Option setters). Property: Source link

Source

pub fn start_date( self, value: impl Into<String>, ) -> DocumentationBuilder<SetStartDate<S>>
where S::StartDate: IsUnset,

Optional (Some / Option setters). Property: Start date

Source

pub fn maybe_start_date( self, value: Option<impl Into<String>>, ) -> DocumentationBuilder<SetStartDate<S>>
where S::StartDate: IsUnset,

Optional (Some / Option setters). Property: Start date

Source

pub fn status( self, value: impl Into<String>, ) -> DocumentationBuilder<SetStatus<S>>
where S::Status: IsUnset,

Optional (Some / Option setters). Property: Status

Source

pub fn maybe_status( self, value: Option<impl Into<String>>, ) -> DocumentationBuilder<SetStatus<S>>
where S::Status: IsUnset,

Optional (Some / Option setters). Property: Status

Source

pub fn summary( self, value: impl Into<String>, ) -> DocumentationBuilder<SetSummary<S>>
where S::Summary: IsUnset,

Optional (Some / Option setters). Property: Summary

Source

pub fn maybe_summary( self, value: Option<impl Into<String>>, ) -> DocumentationBuilder<SetSummary<S>>
where S::Summary: IsUnset,

Optional (Some / Option setters). Property: Summary

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.