Struct SecurityScheme

Source

pub struct SecurityScheme {
    pub key: String,
    pub field: RustIdent,
    pub kind: SecuritySchemeKind,
    pub doc: Option<String>,
}

Expand description

A security scheme the client can apply to outgoing requests.

Derived from a components.securitySchemes entry. only the schemes the client generator can carry as a stored credential are modelled here, plus an SecuritySchemeKind::Unsupported catch-all so an operation that requires an unmodelled scheme (for example OAuth2) can be rejected with a clear message.

Fields§

§key: String

The scheme’s key in components.securitySchemes, matched against each Operation::security entry.

§field: RustIdent

snake_case base name for the generated credential field and the with_<field> builder setter.

§kind: SecuritySchemeKind

How the credential is carried on the request.

§doc: Option<String>

Doc comment derived from the scheme’s description.

SecurityScheme

Struct SecurityScheme Copy item path

Fields§

Trait Implementations§

impl Clone for SecurityScheme

fn clone(&self) -> Self

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

impl Debug for SecurityScheme

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

impl PartialEq for SecurityScheme

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

fn ne(&self, other: &Rhs) -> bool

impl StructuralPartialEq for SecurityScheme

Auto Trait Implementations§

impl Freeze for SecurityScheme

impl RefUnwindSafe for SecurityScheme

impl Send for SecurityScheme

impl Sync for SecurityScheme

impl Unpin for SecurityScheme

impl UnsafeUnpin for SecurityScheme

impl UnwindSafe for SecurityScheme

Blanket Implementations§

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

fn borrow_mut(&mut self) -> &mut T

impl<T> CloneToUninit for Twhere T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

impl<T> From<T> for T

fn from(t: T) -> T

impl<T, U> Into<U> for Twhere U: From<T>,

fn into(self) -> U

impl<D> OwoColorize for D

fn fg<C>(&self) -> FgColorDisplay<'_, C, Self>where C: Color,

fn bg<C>(&self) -> BgColorDisplay<'_, C, Self>where C: Color,

fn black(&self) -> FgColorDisplay<'_, Black, Self>

fn on_black(&self) -> BgColorDisplay<'_, Black, Self>

fn red(&self) -> FgColorDisplay<'_, Red, Self>

fn on_red(&self) -> BgColorDisplay<'_, Red, Self>

fn green(&self) -> FgColorDisplay<'_, Green, Self>

fn on_green(&self) -> BgColorDisplay<'_, Green, Self>

fn yellow(&self) -> FgColorDisplay<'_, Yellow, Self>

fn on_yellow(&self) -> BgColorDisplay<'_, Yellow, Self>

fn blue(&self) -> FgColorDisplay<'_, Blue, Self>

fn on_blue(&self) -> BgColorDisplay<'_, Blue, Self>

fn magenta(&self) -> FgColorDisplay<'_, Magenta, Self>

fn on_magenta(&self) -> BgColorDisplay<'_, Magenta, Self>

fn purple(&self) -> FgColorDisplay<'_, Magenta, Self>

fn on_purple(&self) -> BgColorDisplay<'_, Magenta, Self>

fn cyan(&self) -> FgColorDisplay<'_, Cyan, Self>

fn on_cyan(&self) -> BgColorDisplay<'_, Cyan, Self>

fn white(&self) -> FgColorDisplay<'_, White, Self>

fn on_white(&self) -> BgColorDisplay<'_, White, Self>

fn default_color(&self) -> FgColorDisplay<'_, Default, Self>

fn on_default_color(&self) -> BgColorDisplay<'_, Default, Self>

fn bright_black(&self) -> FgColorDisplay<'_, BrightBlack, Self>

fn on_bright_black(&self) -> BgColorDisplay<'_, BrightBlack, Self>

fn bright_red(&self) -> FgColorDisplay<'_, BrightRed, Self>

fn on_bright_red(&self) -> BgColorDisplay<'_, BrightRed, Self>

fn bright_green(&self) -> FgColorDisplay<'_, BrightGreen, Self>

fn on_bright_green(&self) -> BgColorDisplay<'_, BrightGreen, Self>

fn bright_yellow(&self) -> FgColorDisplay<'_, BrightYellow, Self>

fn on_bright_yellow(&self) -> BgColorDisplay<'_, BrightYellow, Self>

fn bright_blue(&self) -> FgColorDisplay<'_, BrightBlue, Self>

fn on_bright_blue(&self) -> BgColorDisplay<'_, BrightBlue, Self>

fn bright_magenta(&self) -> FgColorDisplay<'_, BrightMagenta, Self>

fn on_bright_magenta(&self) -> BgColorDisplay<'_, BrightMagenta, Self>

fn bright_purple(&self) -> FgColorDisplay<'_, BrightMagenta, Self>

fn on_bright_purple(&self) -> BgColorDisplay<'_, BrightMagenta, Self>

fn bright_cyan(&self) -> FgColorDisplay<'_, BrightCyan, Self>

fn on_bright_cyan(&self) -> BgColorDisplay<'_, BrightCyan, Self>

fn bright_white(&self) -> FgColorDisplay<'_, BrightWhite, Self>

fn on_bright_white(&self) -> BgColorDisplay<'_, BrightWhite, Self>

fn bold(&self) -> BoldDisplay<'_, Self>

fn dimmed(&self) -> DimDisplay<'_, Self>

fn italic(&self) -> ItalicDisplay<'_, Self>

fn underline(&self) -> UnderlineDisplay<'_, Self>

fn blink(&self) -> BlinkDisplay<'_, Self>

Struct SecurityScheme

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

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

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

impl<T> CloneToUninit for T
where T: Clone,

impl<T, U> Into<U> for T
where U: From<T>,

fn fg<C>(&self) -> FgColorDisplay<'_, C, Self>
where C: Color,

fn bg<C>(&self) -> BgColorDisplay<'_, C, Self>
where C: Color,

fn color<Color>(&self, color: Color) -> FgDynColorDisplay<'_, Color, Self>
where Color: DynColor,

fn on_color<Color>(&self, color: Color) -> BgDynColorDisplay<'_, Color, Self>
where Color: DynColor,

impl<T> ToOwned for T
where T: Clone,

impl<T, U> TryFrom<U> for T
where U: Into<T>,

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,