Struct SecurityScheme 

pub struct SecurityScheme { /* private fields */ }

How clients authenticate to an AsyncAPI server, per the AsyncAPI 3.0 security scheme types.

Constructed with the per-kind constructors (scram_sha512, user_password, …) and attached to a server with ServerSpec::with_security. For a scheme shape the constructors do not model, use custom with the raw AsyncAPI security scheme object.

Examples

use ruststream::SecurityScheme;

let scheme = SecurityScheme::user_password().with_description("service credentials");

Implementations

impl SecurityScheme

pub fn user_password() -> Self

Username and password credentials (userPassword).

Examples

use ruststream::SecurityScheme;
let scheme = SecurityScheme::user_password();

pub fn api_key(location: ApiKeyLocation) -> Self

An API key carried in the transport credentials (apiKey).

Examples

use ruststream::{ApiKeyLocation, SecurityScheme};
let scheme = SecurityScheme::api_key(ApiKeyLocation::User);

pub fn x509() -> Self

Mutual TLS with client certificates (X509).

Examples

use ruststream::SecurityScheme;
let scheme = SecurityScheme::x509();

pub fn plain() -> Self

SASL PLAIN (plain).

Examples

use ruststream::SecurityScheme;
let scheme = SecurityScheme::plain();

pub fn scram_sha256() -> Self

SASL SCRAM-SHA-256 (scramSha256).

Examples

use ruststream::SecurityScheme;
let scheme = SecurityScheme::scram_sha256();

pub fn scram_sha512() -> Self

SASL SCRAM-SHA-512 (scramSha512).

Examples

use ruststream::SecurityScheme;
let scheme = SecurityScheme::scram_sha512();

pub fn gssapi() -> Self

SASL GSSAPI / Kerberos (gssapi).

Examples

use ruststream::SecurityScheme;
let scheme = SecurityScheme::gssapi();

pub fn http(scheme: impl Into<String>) -> Self

An HTTP authentication scheme (http), e.g. "basic" or "bearer" - for brokers with HTTP-based control or connection endpoints.

Examples

use ruststream::SecurityScheme;
let scheme = SecurityScheme::http("bearer");

pub fn http_api_key( name: impl Into<String>, location: HttpApiKeyLocation, ) -> Self

An API key in an HTTP query parameter, header, or cookie (httpApiKey).

Examples

use ruststream::{HttpApiKeyLocation, SecurityScheme};
let scheme = SecurityScheme::http_api_key("X-Api-Key", HttpApiKeyLocation::Header);

pub fn open_id_connect(url: impl Into<String>) -> Self

OpenID Connect discovery (openIdConnect), pointing at the provider’s discovery URL.

Examples

use ruststream::SecurityScheme;
let scheme = SecurityScheme::open_id_connect("https://idp.example.com/.well-known/openid-configuration");

pub fn oauth2(flows: Value) -> Self

OAuth2 (oauth2) with the given AsyncAPI flows object, passed as raw JSON (the flows shape is deep and deployment-specific, so it is not modeled field by field).

Examples

use ruststream::SecurityScheme;

let scheme = SecurityScheme::oauth2(serde_json::json!({
    "clientCredentials": {
        "tokenUrl": "https://idp.example.com/token",
        "availableScopes": { "kafka:write": "produce" },
    }
}));

pub fn custom(object: Value) -> Self

An arbitrary AsyncAPI security scheme object, emitted as-is - the escape hatch for kinds or fields the constructors do not model.

Examples

use ruststream::SecurityScheme;

let scheme = SecurityScheme::custom(serde_json::json!({ "type": "symmetricEncryption" }));

pub fn with_description(self, description: impl Into<String>) -> Self

Builder-style setter for the scheme description.

Examples

use ruststream::SecurityScheme;
let scheme = SecurityScheme::plain().with_description("SASL over TLS");

Trait Implementations

impl Clone for SecurityScheme

fn clone(&self) -> SecurityScheme

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SecurityScheme

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

Formats the value using the given formatter.

impl Eq for SecurityScheme

impl PartialEq for SecurityScheme

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for SecurityScheme