Struct AuthenticationRule

#[non_exhaustive]
pub struct AuthenticationRule {
    pub selector: String,
    pub oauth: Option<OAuthRequirements>,
    pub allow_without_credential: bool,
    pub requirements: Vec<AuthRequirement>,
}

Authentication rules for the service.

By default, if a method has any authentication requirements, every request must include a valid credential matching one of the requirements. It’s an error to include more than one kind of credential in a single request.

If a method doesn’t have any auth requirements, request credentials will be ignored.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

selector: String

Selects the methods to which this rule applies.

Refer to selector for syntax details.

oauth: Option<OAuthRequirements>

The requirements for OAuth credentials.

allow_without_credential: bool

If true, the service accepts API keys without any other credential. This flag only applies to HTTP and gRPC requests.

requirements: Vec<AuthRequirement>

Requirements for additional authentication providers.

Implementations

impl AuthenticationRule

pub fn set_selector<T: Into<String>>(self, v: T) -> Self

Sets the value of selector.

pub fn set_oauth<T: Into<Option<OAuthRequirements>>>(self, v: T) -> Self

Sets the value of oauth.

pub fn set_allow_without_credential<T: Into<bool>>(self, v: T) -> Self

Sets the value of allow_without_credential.

pub fn set_requirements<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<AuthRequirement>,

Sets the value of requirements.

Trait Implementations

impl Clone for AuthenticationRule

fn clone(&self) -> AuthenticationRule

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AuthenticationRule

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

Formats the value using the given formatter.

impl Default for AuthenticationRule

fn default() -> AuthenticationRule

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for AuthenticationRule

where AuthenticationRule: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Message for AuthenticationRule

fn typename() -> &'static str

The typename of this message.

impl PartialEq for AuthenticationRule

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for AuthenticationRule

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for AuthenticationRule