#[non_exhaustive]
pub struct SecurityRequirement { /* private fields */ }
Expand description

OpenAPI security requirement object.

Security requirement holds list of required SecurityScheme names and possible scopes required to execute the operation. They can be defined in #[utoipa::path(...)] or in #[openapi(...)] of OpenApi.

Applying the security requirement to OpenApi will make it globally available to all operations. When applied to specific #[utoipa::path(...)] will only make the security requirements available for that operation. Only one of the requirements must be satisfied.

Implementations§

source§

impl SecurityRequirement

source

pub fn new<N: Into<String>, S: IntoIterator<Item = I>, I: Into<String>>( name: N, scopes: S ) -> Self

Construct a new SecurityRequirement

Accepts name for the security requirement which must match to the name of available SecurityScheme. Second parameter is IntoIterator of Into<String> scopes needed by the SecurityRequirement. Scopes must match to the ones defined in SecurityScheme.

Examples

Create new security requirement with scopes.

SecurityRequirement::new("api_oauth2_flow", ["edit:items", "read:items"]);

You can also create an empty security requirement with Default::default().

SecurityRequirement::default();

Trait Implementations§

source§

impl Clone for SecurityRequirement

source§

fn clone(&self) -> SecurityRequirement

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 Debug for SecurityRequirement

source§

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

Formats the value using the given formatter. Read more
source§

impl Default for SecurityRequirement

source§

fn default() -> SecurityRequirement

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

impl<'de> Deserialize<'de> for SecurityRequirement

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 PartialEq<SecurityRequirement> for SecurityRequirement

source§

fn eq(&self, other: &SecurityRequirement) -> 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 SecurityRequirement

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 Eq for SecurityRequirement

source§

impl StructuralEq for SecurityRequirement

source§

impl StructuralPartialEq for SecurityRequirement

Auto Trait Implementations§

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<Q, K> Equivalent<K> for Qwhere Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
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>,