Struct utoipa_swagger_ui::Url

source ·
#[non_exhaustive]
pub struct Url<'a> { /* private fields */ }
Expand description

Rust type for Swagger UI url configuration object.

Implementations§

source§

impl<'a> Url<'a>

source

pub fn new(name: &'a str, url: &'a str) -> Self

Create new Url.

Name is shown in the select dropdown when there are multiple docs in Swagger UI.

Url is path which exposes the OpenAPI doc.

§Examples
let url = Url::new("My Api", "/api-docs/openapi.json");
source

pub fn with_primary(name: &'a str, url: &'a str, primary: bool) -> Self

Create new Url with primary flag.

Primary flag allows users to override the default behavior of the Swagger UI for selecting the primary doc to display. By default when there are multiple docs in Swagger UI the first one in the list will be the primary.

Name is shown in the select dropdown when there are multiple docs in Swagger UI.

Url is path which exposes the OpenAPI doc.

§Examples

Set “My Api” as primary.

let url = Url::with_primary("My Api", "/api-docs/openapi.json", true);

Trait Implementations§

source§

impl<'a> Clone for Url<'a>

source§

fn clone(&self) -> Url<'a>

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<'a> Default for Url<'a>

source§

fn default() -> Url<'a>

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

impl<'a> From<&'a str> for Url<'a>

source§

fn from(url: &'a str) -> Self

Converts to this type from the input type.
source§

impl<'a> From<Cow<'static, str>> for Url<'a>

source§

fn from(url: Cow<'static, str>) -> Self

Converts to this type from the input type.
source§

impl From<String> for Url<'_>

source§

fn from(url: String) -> Self

Converts to this type from the input type.
source§

impl<'a> Serialize for Url<'a>

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

Auto Trait Implementations§

§

impl<'a> Freeze for Url<'a>

§

impl<'a> RefUnwindSafe for Url<'a>

§

impl<'a> Send for Url<'a>

§

impl<'a> Sync for Url<'a>

§

impl<'a> Unpin for Url<'a>

§

impl<'a> UnwindSafe for Url<'a>

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> CloneToUninit for T
where T: Clone,

source§

default unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. 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> Same for T

§

type Output = T

Should always be Self
source§

impl<T> ToOwned for T
where 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 T
where 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 T
where 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<V, T> VZip<V> for T
where V: MultiLane<T>,

source§

fn vzip(self) -> V

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