Struct utoipa::openapi::path::PathItemBuilder
source · pub struct PathItemBuilder { /* private fields */ }
Expand description
Implementations§
source§impl PathItemBuilder
impl PathItemBuilder
sourcepub fn new() -> PathItemBuilder
pub fn new() -> PathItemBuilder
Constructs a new PathItemBuilder
.
source§impl PathItemBuilder
impl PathItemBuilder
sourcepub fn operation<O: Into<Operation>>(
self,
path_item_type: PathItemType,
operation: O,
) -> Self
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
.
sourcepub fn summary<S: Into<String>>(self, summary: Option<S>) -> Self
pub fn summary<S: Into<String>>(self, summary: Option<S>) -> Self
Add or change summary intended to apply all operations in this PathItem
.
sourcepub fn description<S: Into<String>>(self, description: Option<S>) -> Self
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.
sourcepub fn servers<I: IntoIterator<Item = Server>>(self, servers: Option<I>) -> Self
pub fn servers<I: IntoIterator<Item = Server>>(self, servers: Option<I>) -> Self
sourcepub fn parameters<I: IntoIterator<Item = Parameter>>(
self,
parameters: Option<I>,
) -> Self
pub fn parameters<I: IntoIterator<Item = Parameter>>( self, parameters: Option<I>, ) -> Self
Trait Implementations§
source§impl Default for PathItemBuilder
impl Default for PathItemBuilder
source§impl From<PathItem> for PathItemBuilder
impl From<PathItem> for PathItemBuilder
source§impl From<PathItemBuilder> for PathItem
impl From<PathItemBuilder> for PathItem
source§fn from(value: PathItemBuilder) -> Self
fn from(value: PathItemBuilder) -> Self
Converts to this type from the input type.
Auto Trait Implementations§
impl Freeze for PathItemBuilder
impl RefUnwindSafe for PathItemBuilder
impl Send for PathItemBuilder
impl Sync for PathItemBuilder
impl Unpin for PathItemBuilder
impl UnwindSafe for PathItemBuilder
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more