#[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>
Implementations§
source§impl Paths
impl Paths
sourcepub fn get_path_item<P: AsRef<str>>(&self, path: P) -> Option<&PathItem>
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");
sourcepub fn get_path_operation<P: AsRef<str>>(
&self,
path: P,
item_type: PathItemType,
) -> Option<&Operation>
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.
- First will try to find
PathItem
by given relative pathP
e.g."/api/v1/user"
. - Then tries to find
Operation
fromPathItem
’s operations by givenPathItemType
.
§Examples
Get user operation from paths.
let operation = paths.get_path_operation("/api/v1/user", PathItemType::Get);
Trait Implementations§
source§impl<'de> Deserialize<'de> for Paths
impl<'de> Deserialize<'de> for Paths
source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
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
impl From<Paths> for PathsBuilder
source§impl From<PathsBuilder> for Paths
impl From<PathsBuilder> for Paths
source§fn from(value: PathsBuilder) -> Self
fn from(value: PathsBuilder) -> Self
Converts to this type from the input type.
source§impl PartialEq for Paths
impl PartialEq for Paths
impl StructuralPartialEq for Paths
Auto Trait Implementations§
impl Freeze for Paths
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> 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
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§default unsafe fn clone_to_uninit(&self, dst: *mut T)
default unsafe fn clone_to_uninit(&self, dst: *mut T)
🔬This is a nightly-only experimental API. (
clone_to_uninit
)