Struct RefBuilder

Source

pub struct RefBuilder<S: State = Empty> { /* private fields */ }

Expand description

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

Implementations§

Source §

impl<S: State> RefBuilder<S>

Source

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

Finish building and return the requested object

Source

pub fn ref_location( self, value: impl Into<String>, ) -> RefBuilder<SetRefLocation<S>>
where S::RefLocation: IsUnset,

Required.

Reference location of the actual component.

Source

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

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

A description which by default should override that of the referenced component. Description supports markdown syntax. If referenced object type does not support description this field does not have effect.

Source

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

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

A description which by default should override that of the referenced component. Description supports markdown syntax. If referenced object type does not support description this field does not have effect.

Source

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

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

A short summary which by default should override that of the referenced component. If referenced component does not support summary field this does not have effect.

Source

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

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

A short summary which by default should override that of the referenced component. If referenced component does not support summary field this does not have effect.