Struct OperationDocumentation 

pub struct OperationDocumentation {
    pub summary: Option<String>,
    pub description: Option<String>,
    pub deprecated: bool,
}

Human-facing operation documentation independent from OpenAPI structures.

Fields

summary: Option<String>

Short operation summary.

description: Option<String>

Longer operation description.

deprecated: bool

Whether clients should stop adopting this operation.

Implementations

impl OperationDocumentation

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

Sets a non-empty operation summary.

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

Sets a non-empty operation description.

pub const fn deprecated(self) -> Self

Marks the operation as deprecated.

pub fn validate(&self) -> SoapResult<()>

Validates documentation after direct public-field mutation.

Trait Implementations

impl Clone for OperationDocumentation

fn clone(&self) -> OperationDocumentation

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OperationDocumentation

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

Formats the value using the given formatter.

impl Default for OperationDocumentation

fn default() -> OperationDocumentation

Returns the “default value” for a type.

impl Eq for OperationDocumentation

impl PartialEq for OperationDocumentation

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for OperationDocumentation