pub struct ApiKeyOwnedView(/* private fields */);Expand description
Self-contained, 'static owned view of a ApiKey message.
Wraps ::buffa::OwnedView<ApiKeyView<'static>>: the decoded view and the ::buffa::bytes::Bytes buffer it borrows from travel together, so the handle is 'static and Send + Sync — suitable for async handlers, spawned tasks, and anywhere a 'static bound is required.
Field accessors return borrows tied to &self. Use Self::view to get the full ApiKeyView when you need struct patterns, iteration helpers, or to pass the view to lifetime-parameterised code.
Implementations§
Source§impl ApiKeyOwnedView
impl ApiKeyOwnedView
Sourcepub fn decode(bytes: Bytes) -> Result<Self, DecodeError>
pub fn decode(bytes: Bytes) -> Result<Self, DecodeError>
Decode an owned view from a ::buffa::bytes::Bytes buffer.
The view borrows directly from the buffer’s data; the buffer is retained inside the returned handle.
§Errors
Returns ::buffa::DecodeError if the buffer contains invalid
protobuf data.
Sourcepub fn decode_with_options(
bytes: Bytes,
opts: &DecodeOptions,
) -> Result<Self, DecodeError>
pub fn decode_with_options( bytes: Bytes, opts: &DecodeOptions, ) -> Result<Self, DecodeError>
Decode with custom ::buffa::DecodeOptions (recursion limit,
max message size).
§Errors
Returns ::buffa::DecodeError if the buffer is invalid or
exceeds the configured limits.
Sourcepub fn from_owned(msg: &ApiKey) -> Result<Self, DecodeError>
pub fn from_owned(msg: &ApiKey) -> Result<Self, DecodeError>
Build from an owned message via an encode → decode round-trip.
§Errors
Returns ::buffa::DecodeError if the re-encoded bytes are
somehow invalid (should not happen for well-formed messages).
Sourcepub fn view(&self) -> &ApiKeyView<'_>
pub fn view(&self) -> &ApiKeyView<'_>
Borrow the full ApiKeyView with its lifetime tied to &self.
Sourcepub fn to_owned_message(&self) -> Result<ApiKey, DecodeError>
pub fn to_owned_message(&self) -> Result<ApiKey, DecodeError>
Convert to the owned message type.
§Errors
Returns an error if re-materializing preserved unknown fields fails (e.g. the unknown-field limit is exceeded).
Sourcepub fn into_bytes(self) -> Bytes
pub fn into_bytes(self) -> Bytes
Consume the handle, returning the underlying bytes buffer.
Sourcepub fn key_id(&self) -> &str
pub fn key_id(&self) -> &str
Stable opaque identifier used to refer to this key, formatted as “ak_” followed by 32 lowercase hex characters.
Field 2: key_id
Sourcepub fn label(&self) -> &str
pub fn label(&self) -> &str
Human-readable label for the key. Maximum length is 64 characters.
Field 3: label
Sourcepub fn ip_whitelist(&self) -> &RepeatedView<'_, &str>
pub fn ip_whitelist(&self) -> &RepeatedView<'_, &str>
Optional CIDR whitelist. Empty means no IP restriction. Maximum 32 unique entries.
Field 4: ip_whitelist
Sourcepub fn status(&self) -> EnumValue<ApiKeyStatus>
pub fn status(&self) -> EnumValue<ApiKeyStatus>
Current key status.
Field 6: status
Sourcepub fn subaccount_id(&self) -> Option<u64>
pub fn subaccount_id(&self) -> Option<u64>
Optional sub-account this key is scoped to (opaque ID; empty = root-level).
Field 7: subaccount_id
Sourcepub fn policy_id(&self) -> Option<u64>
pub fn policy_id(&self) -> Option<u64>
Optional API policy attached to this key (opaque ID). Empty means “no per-key policy”, so only the sub-account policy (and roles) apply.
Field 8: policy_id
Sourcepub fn created_at(&self) -> &MessageFieldView<TimestampView<'_>>
pub fn created_at(&self) -> &MessageFieldView<TimestampView<'_>>
Time in UTC when this key was created.
Field 20: created_at
Sourcepub fn last_used_at(&self) -> &MessageFieldView<TimestampView<'_>>
pub fn last_used_at(&self) -> &MessageFieldView<TimestampView<'_>>
Last time in UTC when this key authenticated a request. Omitted when the key has not been used.
Field 21: last_used_at
Sourcepub fn public_key_ed25519(&self) -> &[u8] ⓘ
pub fn public_key_ed25519(&self) -> &[u8] ⓘ
Ed25519 public key bytes associated with this API key. The private key or seed is never returned by the API.
Field 22: public_key_ed25519
Sourcepub fn expires_at(&self) -> &MessageFieldView<TimestampView<'_>>
pub fn expires_at(&self) -> &MessageFieldView<TimestampView<'_>>
Optional expiry time in UTC. When set, the key cannot authenticate requests after this time, regardless of status.
Field 23: expires_at
Sourcepub fn created_by_actor(&self) -> &str
pub fn created_by_actor(&self) -> &str
Read-only actor label describing who created this key, such as a username or account label.
Field 24: created_by_actor
Sourcepub fn updated_at(&self) -> &MessageFieldView<TimestampView<'_>>
pub fn updated_at(&self) -> &MessageFieldView<TimestampView<'_>>
Time in UTC when this key’s configuration was last changed. For the same key, later is fresher, equal is an idempotent replay, and earlier is stale. Equal timestamps with different configuration indicate an invariant failure. This is independent of last_used_at, which tracks authentication activity.
Field 25: updated_at
Trait Implementations§
Source§impl AsRef<OwnedView<ApiKeyView<'static>>> for ApiKeyOwnedView
impl AsRef<OwnedView<ApiKeyView<'static>>> for ApiKeyOwnedView
Source§fn as_ref(&self) -> &OwnedView<ApiKeyView<'static>>
fn as_ref(&self) -> &OwnedView<ApiKeyView<'static>>
Source§impl Clone for ApiKeyOwnedView
impl Clone for ApiKeyOwnedView
Source§fn clone(&self) -> ApiKeyOwnedView
fn clone(&self) -> ApiKeyOwnedView
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read more