pub struct ApiPolicySpecOwnedView(/* private fields */);Expand description
Self-contained, 'static owned view of a ApiPolicySpec message.
Wraps ::buffa::OwnedView<ApiPolicySpecView<'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 ApiPolicySpecView when you need struct patterns, iteration helpers, or to pass the view to lifetime-parameterised code.
Implementations§
Source§impl ApiPolicySpecOwnedView
impl ApiPolicySpecOwnedView
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: &ApiPolicySpec) -> Result<Self, DecodeError>
pub fn from_owned(msg: &ApiPolicySpec) -> 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) -> &ApiPolicySpecView<'_>
pub fn view(&self) -> &ApiPolicySpecView<'_>
Borrow the full ApiPolicySpecView with its lifetime tied to &self.
Sourcepub fn to_owned_message(&self) -> Result<ApiPolicySpec, DecodeError>
pub fn to_owned_message(&self) -> Result<ApiPolicySpec, 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 name(&self) -> &str
pub fn name(&self) -> &str
Human-readable policy name. Create requires a non-empty value; update validates it after merging fields selected by update_mask.
Field 1: name
Sourcepub fn description(&self) -> &str
pub fn description(&self) -> &str
Optional policy description for dashboards and audits. Maximum 256 characters.
Field 2: description
Sourcepub fn spot_markets(&self) -> &RepeatedView<'_, SpotMarketRuleView<'_>>
pub fn spot_markets(&self) -> &RepeatedView<'_, SpotMarketRuleView<'_>>
Allowed spot markets for this API key policy.
Field 3: spot_markets
Sourcepub fn perp_markets(&self) -> &RepeatedView<'_, PerpMarketRuleView<'_>>
pub fn perp_markets(&self) -> &RepeatedView<'_, PerpMarketRuleView<'_>>
Allowed perp markets and optional per-contract leverage caps.
Field 4: perp_markets
Sourcepub fn spot_market_scope(&self) -> EnumValue<Value>
pub fn spot_market_scope(&self) -> EnumValue<Value>
Market-level scope for spot markets. When unspecified, defaults to ALL.
Field 5: spot_market_scope
Sourcepub fn perp_market_scope(&self) -> EnumValue<Value>
pub fn perp_market_scope(&self) -> EnumValue<Value>
Market-level scope for perp contracts. When unspecified, defaults to ALL.
Field 6: perp_market_scope
Sourcepub fn actions(&self) -> &RepeatedView<'_, EnumValue<PolicyAction>>
pub fn actions(&self) -> &RepeatedView<'_, EnumValue<PolicyAction>>
High-level actions enabled for the API key policy. Up to 64 unique explicit actions are allowed.
Field 7: actions
Sourcepub fn max_order_notional(&self) -> u64
pub fn max_order_notional(&self) -> u64
Maximum notional size for any single order submitted with this API key, expressed in the canonical quote unit (for example, micro-USDT). A value of 0 means no additional cap beyond the sub-account policy.
Field 13: max_order_notional
Sourcepub fn daily_internal_transfer_out_limit(&self) -> u64
pub fn daily_internal_transfer_out_limit(&self) -> u64
Maximum total notional this API key can transfer out internally per rolling day, expressed in the canonical quote unit (for example, micro-USDT). A value of 0 means no additional cap beyond the sub-account policy.
Field 17: daily_internal_transfer_out_limit
Sourcepub fn daily_withdraw_limit(&self) -> u64
pub fn daily_withdraw_limit(&self) -> u64
Maximum total notional this API key can withdraw per rolling day, expressed in the canonical quote unit (for example, micro-USDT). A value of 0 means no additional cap beyond the sub-account policy.
Field 18: daily_withdraw_limit
Sourcepub fn is_template(&self) -> bool
pub fn is_template(&self) -> bool
Whether this policy should be treated as a reusable template.
Field 19: is_template
Trait Implementations§
Source§impl AsRef<OwnedView<ApiPolicySpecView<'static>>> for ApiPolicySpecOwnedView
impl AsRef<OwnedView<ApiPolicySpecView<'static>>> for ApiPolicySpecOwnedView
Source§fn as_ref(&self) -> &OwnedView<ApiPolicySpecView<'static>>
fn as_ref(&self) -> &OwnedView<ApiPolicySpecView<'static>>
Source§impl Clone for ApiPolicySpecOwnedView
impl Clone for ApiPolicySpecOwnedView
Source§fn clone(&self) -> ApiPolicySpecOwnedView
fn clone(&self) -> ApiPolicySpecOwnedView
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read more