Enum google_api_proto::google::cloud::kms::v1::crypto_key::CryptoKeyPurpose

#[repr(i32)]
pub enum CryptoKeyPurpose {
    Unspecified = 0,
    EncryptDecrypt = 1,
    AsymmetricSign = 5,
    AsymmetricDecrypt = 6,
    RawEncryptDecrypt = 7,
    Mac = 9,
}

[CryptoKeyPurpose][google.cloud.kms.v1.CryptoKey.CryptoKeyPurpose] describes the cryptographic capabilities of a [CryptoKey][google.cloud.kms.v1.CryptoKey]. A given key can only be used for the operations allowed by its purpose. For more information, see Key purposes.

Variants

Unspecified = 0

Not specified.

EncryptDecrypt = 1

[CryptoKeys][google.cloud.kms.v1.CryptoKey] with this purpose may be used with [Encrypt][google.cloud.kms.v1.KeyManagementService.Encrypt] and [Decrypt][google.cloud.kms.v1.KeyManagementService.Decrypt].

AsymmetricSign = 5

[CryptoKeys][google.cloud.kms.v1.CryptoKey] with this purpose may be used with [AsymmetricSign][google.cloud.kms.v1.KeyManagementService.AsymmetricSign] and [GetPublicKey][google.cloud.kms.v1.KeyManagementService.GetPublicKey].

AsymmetricDecrypt = 6

[CryptoKeys][google.cloud.kms.v1.CryptoKey] with this purpose may be used with [AsymmetricDecrypt][google.cloud.kms.v1.KeyManagementService.AsymmetricDecrypt] and [GetPublicKey][google.cloud.kms.v1.KeyManagementService.GetPublicKey].

RawEncryptDecrypt = 7

[CryptoKeys][google.cloud.kms.v1.CryptoKey] with this purpose may be used with [RawEncrypt][google.cloud.kms.v1.KeyManagementService.RawEncrypt] and [RawDecrypt][google.cloud.kms.v1.KeyManagementService.RawDecrypt]. This purpose is meant to be used for interoperable symmetric encryption and does not support automatic CryptoKey rotation.

Mac = 9

[CryptoKeys][google.cloud.kms.v1.CryptoKey] with this purpose may be used with [MacSign][google.cloud.kms.v1.KeyManagementService.MacSign].

Implementations

impl CryptoKeyPurpose

pub fn is_valid(value: i32) -> bool

Returns true if value is a variant of CryptoKeyPurpose.

pub fn from_i32(value: i32) -> Option<CryptoKeyPurpose>

👎Deprecated: Use the TryFrom<i32> implementation instead

Converts an i32 to a CryptoKeyPurpose, or None if value is not a valid variant.

impl CryptoKeyPurpose

pub fn as_str_name(&self) -> &'static str

String value of the enum field names used in the ProtoBuf definition.

The values are not transformed in any way and thus are considered stable (if the ProtoBuf definition does not change) and safe for programmatic use.

pub fn from_str_name(value: &str) -> Option<Self>

Creates an enum from field names used in the ProtoBuf definition.

Trait Implementations

impl Clone for CryptoKeyPurpose

fn clone(&self) -> CryptoKeyPurpose

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CryptoKeyPurpose

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

Formats the value using the given formatter.

impl Default for CryptoKeyPurpose

fn default() -> CryptoKeyPurpose

Returns the “default value” for a type.

impl From<CryptoKeyPurpose> for i32

fn from(value: CryptoKeyPurpose) -> i32

Converts to this type from the input type.

impl Hash for CryptoKeyPurpose

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for CryptoKeyPurpose

fn cmp(&self, other: &CryptoKeyPurpose) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for CryptoKeyPurpose

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

This method tests for self and other values to be equal, and is used by ==.

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.

impl PartialOrd for CryptoKeyPurpose

fn partial_cmp(&self, other: &CryptoKeyPurpose) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl TryFrom<i32> for CryptoKeyPurpose

type Error = UnknownEnumValue

The type returned in the event of a conversion error.

fn try_from(value: i32) -> Result<CryptoKeyPurpose, UnknownEnumValue>

Performs the conversion.

impl Copy for CryptoKeyPurpose

impl Eq for CryptoKeyPurpose

impl StructuralPartialEq for CryptoKeyPurpose