Struct utoipa::openapi::path::Paths

source ·
#[non_exhaustive]
pub struct Paths { pub paths: BTreeMap<String, PathItem>, }
Expand description

Implements OpenAPI Paths Object.

Holds relative paths to matching endpoints and operations. The path is appended to the url from Server object to construct a full url for endpoint.

Fields (Non-exhaustive)§

This struct is marked as 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.
§paths: BTreeMap<String, PathItem>

Map of relative paths with PathItems holding Operations matching api endpoints.

Implementations§

source§

impl Paths

source

pub fn new() -> Self

Construct a new Paths object.

source

pub fn get_path_item<P: AsRef<str>>(&self, path: P) -> Option<&PathItem>

Return Option of reference to PathItem by given relative path P if one exists in Paths::paths map. Otherwise will return None.

Examples

Get user path item.

let path_item = paths.get_path_item("/api/v1/user");
source

pub fn get_path_operation<P: AsRef<str>>( &self, path: P, item_type: PathItemType ) -> Option<&Operation>

Return Option of reference to Operation from map of paths or None if not found.

Examples

Get user operation from paths.

let operation = paths.get_path_operation("/api/v1/user", PathItemType::Get);

Trait Implementations§

source§

impl Clone for Paths

source§

fn clone(&self) -> Paths

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Default for Paths

source§

fn default() -> Paths

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

impl<'de> Deserialize<'de> for Paths

source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
source§

impl From<Paths> for PathsBuilder

source§

fn from(value: Paths) -> Self

Converts to this type from the input type.
source§

impl From<PathsBuilder> for Paths

source§

fn from(value: PathsBuilder) -> Self

Converts to this type from the input type.
source§

impl PartialEq<Paths> for Paths

source§

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

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

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.
source§

impl Serialize for Paths

source§

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

Serialize this value into the given Serde serializer. Read more
source§

impl StructuralPartialEq for Paths

Auto Trait Implementations§

§

impl RefUnwindSafe for Paths

§

impl Send for Paths

§

impl Sync for Paths

§

impl Unpin for Paths

§

impl UnwindSafe for Paths

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere 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 Twhere 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> ToOwned for Twhere T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for Twhere 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 Twhere 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.
source§

impl<T> DeserializeOwned for Twhere T: for<'de> Deserialize<'de>,