Struct utoipa::openapi::path::PathItemBuilder

source ·
pub struct PathItemBuilder { /* private fields */ }
Expand description

Builder for PathItem with chainable configuration methods to create a new PathItem.

Implementations§

source§

impl PathItemBuilder

source

pub fn new() -> PathItemBuilder

Constructs a new PathItemBuilder.

source

pub fn build(self) -> PathItem

Constructs a new PathItem taking all fields values from this object.

source§

impl PathItemBuilder

source

pub fn operation<O: Into<Operation>>( self, path_item_type: PathItemType, operation: O, ) -> Self

Append a new Operation by PathItemType to this PathItem. Operations can hold only one operation per PathItemType.

source

pub fn summary<S: Into<String>>(self, summary: Option<S>) -> Self

Add or change summary intended to apply all operations in this PathItem.

source

pub fn description<S: Into<String>>(self, description: Option<S>) -> Self

Add or change optional description intended to apply all operations in this PathItem. Description supports markdown syntax.

source

pub fn servers<I: IntoIterator<Item = Server>>(self, servers: Option<I>) -> Self

Add list of alternative Servers to serve all Operations in this PathItem overriding the global server array.

source

pub fn parameters<I: IntoIterator<Item = Parameter>>( self, parameters: Option<I>, ) -> Self

Append list of Parameters common to all Operations to this PathItem.

Trait Implementations§

source§

impl Default for PathItemBuilder

source§

fn default() -> Self

Returns the “default value” for a type. Read more
source§

impl From<PathItem> for PathItemBuilder

source§

fn from(value: PathItem) -> Self

Converts to this type from the input type.
source§

impl From<PathItemBuilder> for PathItem

source§

fn from(value: PathItemBuilder) -> Self

Converts to this type from the input type.

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>,

§

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>,

§

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.