Skip to main content

ApiKeyOwnedView

Struct ApiKeyOwnedView 

Source
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

Source

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.

Source

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.

Source

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).

Source

pub fn view(&self) -> &ApiKeyView<'_>

Borrow the full ApiKeyView with its lifetime tied to &self.

Source

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).

Source

pub fn bytes(&self) -> &Bytes

The underlying bytes buffer.

Source

pub fn into_bytes(self) -> Bytes

Consume the handle, returning the underlying bytes buffer.

Source

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

Source

pub fn label(&self) -> &str

Human-readable label for the key. Maximum length is 64 characters.

Field 3: label

Source

pub fn icon(&self) -> &str

Optional user-chosen icon/emoji for UI display.

Field 9: icon

Source

pub fn color(&self) -> &str

Optional user-chosen color token for UI display.

Field 10: color

Source

pub fn ip_whitelist(&self) -> &RepeatedView<'_, &str>

Optional CIDR whitelist. Empty means no IP restriction. Maximum 32 unique entries.

Field 4: ip_whitelist

Source

pub fn status(&self) -> EnumValue<ApiKeyStatus>

Current key status.

Field 6: status

Source

pub fn subaccount_id(&self) -> Option<u64>

Optional sub-account this key is scoped to (opaque ID; empty = root-level).

Field 7: subaccount_id

Source

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

Source

pub fn created_at(&self) -> &MessageFieldView<TimestampView<'_>>

Time in UTC when this key was created.

Field 20: created_at

Source

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

Source

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

Source

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

Source

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

Source

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

Source

pub fn revision(&self) -> u64

Monotonic resource revision used for conditional updates.

Field 26: revision

Trait Implementations§

Source§

impl AsRef<OwnedView<ApiKeyView<'static>>> for ApiKeyOwnedView

Source§

fn as_ref(&self) -> &OwnedView<ApiKeyView<'static>>

Converts this type into a shared reference of the (usually inferred) input type.
Source§

impl Clone for ApiKeyOwnedView

Source§

fn clone(&self) -> ApiKeyOwnedView

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ApiKeyOwnedView

Source§

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

Formats the value using the given formatter. Read more
Source§

impl From<ApiKeyOwnedView> for OwnedView<ApiKeyView<'static>>

Source§

fn from(wrapper: ApiKeyOwnedView) -> Self

Converts to this type from the input type.
Source§

impl From<OwnedView<ApiKeyView<'static>>> for ApiKeyOwnedView

Source§

fn from(inner: OwnedView<ApiKeyView<'static>>) -> Self

Converts to this type from the input type.
Source§

impl Serialize for ApiKeyOwnedView

Source§

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

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

Source§

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

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

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

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> JsonSerialize for T
where T: Serialize,

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

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

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more