Struct PathsBuilder

Source
pub struct PathsBuilder { /* private fields */ }
Expand description

Builder for Paths with chainable configuration methods to create a new Paths.

Implementations§

Source§

impl PathsBuilder

Source

pub fn new() -> PathsBuilder

Constructs a new PathsBuilder.

Source

pub fn build(self) -> Paths

Constructs a new Paths taking all fields values from this object.

Source§

impl PathsBuilder

Source

pub fn path<I>(self, path: I, item: PathItem) -> PathsBuilder
where I: Into<String>,

Append PathItem with path to map of paths. If path already exists it will merge Operations of PathItem with already found path item operations.

Source

pub fn extensions(self, extensions: Option<Extensions>) -> PathsBuilder

Add extensions to the paths section.

Source

pub fn path_from<P>(self) -> PathsBuilder
where P: Path,

Appends a Path to map of paths. Method must be called with one generic argument that implements Path trait.

§Examples

Append MyPath content to the paths.

let paths = utoipa::openapi::path::PathsBuilder::new();
let _ = paths.path_from::<MyPath>();

Trait Implementations§

Source§

impl Default for PathsBuilder

Source§

fn default() -> PathsBuilder

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

impl From<Paths> for PathsBuilder

Source§

fn from(value: Paths) -> PathsBuilder

Converts to this type from the input type.
Source§

impl From<PathsBuilder> for Paths

Source§

fn from(value: PathsBuilder) -> Paths

Converts to this type from the input type.

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where 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> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where 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, U> TryFrom<U> for T
where U: Into<T>,

Source§

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 T
where U: TryFrom<T>,

Source§

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> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,