Struct LinkBuilder

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

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

Implementations

impl<S: State> LinkBuilder<S>

pub fn build(self) -> Link

where S: IsComplete,

Finish building and return the requested object

pub fn operation_ref( self, value: impl Into<String>, ) -> LinkBuilder<SetOperationRef<S>>

where S::OperationRef: IsUnset,

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

A relative or absolute URI reference to an OAS operation. This field is mutually exclusive of the operation_id field, and must point to an Operation Object. Relative operation_ref values may be used to locate an existing Operation Object in the OpenAPI definition. See the rules for resolving Relative References.

pub fn maybe_operation_ref( self, value: Option<impl Into<String>>, ) -> LinkBuilder<SetOperationRef<S>>

where S::OperationRef: IsUnset,

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

A relative or absolute URI reference to an OAS operation. This field is mutually exclusive of the operation_id field, and must point to an Operation Object. Relative operation_ref values may be used to locate an existing Operation Object in the OpenAPI definition. See the rules for resolving Relative References.

pub fn operation_id( self, value: impl Into<String>, ) -> LinkBuilder<SetOperationId<S>>

where S::OperationId: IsUnset,

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

The name of an existing, resolvable OAS operation, as defined with a unique operation_id. This field is mutually exclusive of the operation_ref field.

pub fn maybe_operation_id( self, value: Option<impl Into<String>>, ) -> LinkBuilder<SetOperationId<S>>

where S::OperationId: IsUnset,

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

The name of an existing, resolvable OAS operation, as defined with a unique operation_id. This field is mutually exclusive of the operation_ref field.

pub fn request_body( self, value: impl Into<Value>, ) -> LinkBuilder<SetRequestBody<S>>

where S::RequestBody: IsUnset,

Optional (Some / Option setters).

A literal value or an expression to be used as request body when operation is called.

pub fn maybe_request_body( self, value: Option<impl Into<Value>>, ) -> LinkBuilder<SetRequestBody<S>>

where S::RequestBody: IsUnset,

Optional (Some / Option setters).

A literal value or an expression to be used as request body when operation is called.

pub fn description( self, value: impl Into<String>, ) -> LinkBuilder<SetDescription<S>>

where S::Description: IsUnset,

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

Description of the link. Value supports Markdown syntax.

pub fn maybe_description( self, value: Option<impl Into<String>>, ) -> LinkBuilder<SetDescription<S>>

where S::Description: IsUnset,

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

Description of the link. Value supports Markdown syntax.

pub fn server(self, value: impl Into<Server>) -> LinkBuilder<SetServer<S>>

where S::Server: IsUnset,

Optional (Some / Option setters).

A Server object to be used by the target operation.

pub fn maybe_server( self, value: Option<impl Into<Server>>, ) -> LinkBuilder<SetServer<S>>

where S::Server: IsUnset,

Optional (Some / Option setters).

A Server object to be used by the target operation.

pub fn extensions( self, value: impl Into<Extensions>, ) -> LinkBuilder<SetExtensions<S>>

where S::Extensions: IsUnset,

Optional (Some / Option setters).

Optional extensions “x-something”.

pub fn maybe_extensions( self, value: Option<impl Into<Extensions>>, ) -> LinkBuilder<SetExtensions<S>>

where S::Extensions: IsUnset,

Optional (Some / Option setters).

Optional extensions “x-something”.

impl<S: State> LinkBuilder<S>

pub fn parameters<N: Into<String>, V: Into<Value>>( self, items: impl IntoIterator<Item = (N, V)>, ) -> Self

Add parameters to be passed to Operation upon execution.

pub fn parameter<N: Into<String>, V: Into<Value>>( self, name: N, value: V, ) -> Self

Add parameter to be passed to Operation upon execution.

Trait Implementations

impl<S: IsComplete> From<LinkBuilder<S>> for Link

fn from(builder: LinkBuilder<S>) -> Self

Converts to this type from the input type.