Struct salvo_oapi::PathItem

#[non_exhaustive]
pub struct PathItem {
    pub summary: Option<String>,
    pub description: Option<String>,
    pub servers: Servers,
    pub parameters: Parameters,
    pub operations: Operations,
}

Implements OpenAPI Path Item Object what describes Operations available on a single path.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

summary: Option<String>

Optional summary intended to apply all operations in this PathItem.

description: Option<String>

Optional description intended to apply all operations in this PathItem. Description supports markdown syntax.

servers: Servers

Alternative Server array to serve all Operations in this PathItem overriding the global server array.

parameters: Parameters

List of Parameters common to all Operations in this PathItem. Parameters cannot contain duplicate parameters. They can be overridden in Operation level but cannot be removed there.

operations: Operations

Map of operations in this PathItem. Operations can hold only one operation per PathItemType.

Implementations

impl PathItem

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

Construct a new PathItem with provided Operation mapped to given PathItemType.

pub fn append(&mut self, other: &mut Self)

Moves all elements from other into self, leaving other empty.

If a key from other is already present in self, the respective value from self will be overwritten with the respective value from other.

pub fn add_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.

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

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

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

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

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

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

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

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

Trait Implementations

impl Clone for PathItem

fn clone(&self) -> PathItem

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PathItem

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for PathItem

fn default() -> PathItem

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for PathItem

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for PathItem

fn eq(&self, other: &PathItem) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for PathItem

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for PathItem