pub struct ApiPolicySpecView<'a> {
pub name: &'a str,
pub description: &'a str,
pub spot_markets: RepeatedView<'a, SpotMarketRuleView<'a>>,
pub perp_markets: RepeatedView<'a, PerpMarketRuleView<'a>>,
pub spot_market_scope: EnumValue<Value>,
pub perp_market_scope: EnumValue<Value>,
pub actions: RepeatedView<'a, EnumValue<PolicyAction>>,
pub max_order_notional: u64,
pub daily_internal_transfer_out_limit: u64,
pub daily_withdraw_limit: u64,
pub is_template: bool,
pub __buffa_unknown_fields: UnknownFieldsView<'a>,
}Expand description
ApiPolicySpec contains the mutable configuration of an API key policy.
Fields§
§name: &'a strHuman-readable policy name. Create requires a non-empty value; update validates it after merging fields selected by update_mask.
Field 1: name
description: &'a strOptional policy description for dashboards and audits. Maximum 256 characters.
Field 2: description
spot_markets: RepeatedView<'a, SpotMarketRuleView<'a>>Allowed spot markets for this API key policy.
Field 3: spot_markets
perp_markets: RepeatedView<'a, PerpMarketRuleView<'a>>Allowed perp markets and optional per-contract leverage caps.
Field 4: perp_markets
spot_market_scope: EnumValue<Value>Market-level scope for spot markets. When unspecified, defaults to ALL.
Field 5: spot_market_scope
perp_market_scope: EnumValue<Value>Market-level scope for perp contracts. When unspecified, defaults to ALL.
Field 6: perp_market_scope
actions: RepeatedView<'a, EnumValue<PolicyAction>>High-level actions enabled for the API key policy. Up to 64 unique explicit actions are allowed.
Field 7: actions
max_order_notional: u64Maximum 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
daily_internal_transfer_out_limit: u64Maximum 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
daily_withdraw_limit: u64Maximum 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
is_template: boolWhether this policy should be treated as a reusable template.
Field 19: is_template
__buffa_unknown_fields: UnknownFieldsView<'a>Trait Implementations§
Source§impl<'a> Clone for ApiPolicySpecView<'a>
impl<'a> Clone for ApiPolicySpecView<'a>
Source§fn clone(&self) -> ApiPolicySpecView<'a>
fn clone(&self) -> ApiPolicySpecView<'a>
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl<'a> Debug for ApiPolicySpecView<'a>
impl<'a> Debug for ApiPolicySpecView<'a>
Source§impl<'a> Default for ApiPolicySpecView<'a>
impl<'a> Default for ApiPolicySpecView<'a>
Source§fn default() -> ApiPolicySpecView<'a>
fn default() -> ApiPolicySpecView<'a>
Source§impl<'v> DefaultViewInstance for ApiPolicySpecView<'v>
impl<'v> DefaultViewInstance for ApiPolicySpecView<'v>
Source§fn default_view_instance<'a>() -> &'a Selfwhere
Self: 'a,
fn default_view_instance<'a>() -> &'a Selfwhere
Self: 'a,
Source§impl<'a> MessageName for ApiPolicySpecView<'a>
impl<'a> MessageName for ApiPolicySpecView<'a>
Source§const PACKAGE: &'static str = "auth.v1"
const PACKAGE: &'static str = "auth.v1"
Source§const NAME: &'static str = "ApiPolicySpec"
const NAME: &'static str = "ApiPolicySpec"
. between nesting levels. Read moreSource§impl<'a> MessageView<'a> for ApiPolicySpecView<'a>
impl<'a> MessageView<'a> for ApiPolicySpecView<'a>
Source§type Owned = ApiPolicySpec
type Owned = ApiPolicySpec
Source§fn decode_view(buf: &'a [u8]) -> Result<Self, DecodeError>
fn decode_view(buf: &'a [u8]) -> Result<Self, DecodeError>
Source§fn decode_view_with_ctx(
buf: &'a [u8],
ctx: DecodeContext<'_>,
) -> Result<Self, DecodeError>
fn decode_view_with_ctx( buf: &'a [u8], ctx: DecodeContext<'_>, ) -> Result<Self, DecodeError>
Source§fn merge_view_field(
&mut self,
tag: Tag,
cur: &'a [u8],
before_tag: &'a [u8],
ctx: DecodeContext<'_>,
) -> Result<&'a [u8], DecodeError>
fn merge_view_field( &mut self, tag: Tag, cur: &'a [u8], before_tag: &'a [u8], ctx: DecodeContext<'_>, ) -> Result<&'a [u8], DecodeError>
Source§fn to_owned_message(&self) -> Result<ApiPolicySpec, DecodeError>
fn to_owned_message(&self) -> Result<ApiPolicySpec, DecodeError>
Source§fn to_owned_from_source(
&self,
__buffa_src: Option<&Bytes>,
) -> Result<ApiPolicySpec, DecodeError>
fn to_owned_from_source( &self, __buffa_src: Option<&Bytes>, ) -> Result<ApiPolicySpec, DecodeError>
bytes::Bytes-typed fields from source instead of copying. Read moreSource§fn decode_view_ctx(
buf: &'a [u8],
ctx: DecodeContext<'_>,
) -> Result<Self, DecodeError>where
Self: Default,
fn decode_view_ctx(
buf: &'a [u8],
ctx: DecodeContext<'_>,
) -> Result<Self, DecodeError>where
Self: Default,
DecodeContext
(remaining recursion depth and unknown-field allowance), driving the
provided tag loop over merge_view_field. Read moreSource§fn merge_into_view(
&mut self,
buf: &'a [u8],
ctx: DecodeContext<'_>,
) -> Result<(), DecodeError>
fn merge_into_view( &mut self, buf: &'a [u8], ctx: DecodeContext<'_>, ) -> Result<(), DecodeError>
buf into this view (proto merge semantics):
repeated fields append, singular fields last-wins, singular message
fields merge recursively. Read moreSource§impl<'__a> Serialize for ApiPolicySpecView<'__a>
Serializes this view as protobuf JSON.
impl<'__a> Serialize for ApiPolicySpecView<'__a>
Serializes this view as protobuf JSON.
Implicit-presence fields with default values are omitted, required
fields are always emitted, explicit-presence (optional) fields are
emitted only when set, bytes fields are base64-encoded, and enum
values are their proto name strings.
This impl uses serialize_map(None) because the number of emitted
fields depends on default-omission rules; serializers that require
known map lengths (e.g. bincode) will return a runtime error.
Use the owned message type for those formats.
Source§impl<'a> ViewEncode<'a> for ApiPolicySpecView<'a>
impl<'a> ViewEncode<'a> for ApiPolicySpecView<'a>
Source§fn compute_size(&self, __cache: &mut SizeCache) -> u32
fn compute_size(&self, __cache: &mut SizeCache) -> u32
Source§fn write_to(&self, __cache: &mut SizeCache, buf: &mut impl BufMut)
fn write_to(&self, __cache: &mut SizeCache, buf: &mut impl BufMut)
cache (populated by a prior
compute_size call on the same cache). Read moreSource§fn encode(&self, buf: &mut impl BufMut)
fn encode(&self, buf: &mut impl BufMut)
Source§fn encode_with_cache(&self, cache: &mut SizeCache, buf: &mut impl BufMut)
fn encode_with_cache(&self, cache: &mut SizeCache, buf: &mut impl BufMut)
SizeCache, for
reuse across many encodes in a hot loop. Clears the cache first.Source§fn encoded_len(&self) -> u32
fn encoded_len(&self) -> u32
Source§fn encode_length_delimited(&self, buf: &mut impl BufMut)
fn encode_length_delimited(&self, buf: &mut impl BufMut)
Source§fn encode_to_bytes(&self) -> Bytes
fn encode_to_bytes(&self) -> Bytes
bytes::Bytes.Source§impl ViewReborrow for ApiPolicySpecView<'static>
impl ViewReborrow for ApiPolicySpecView<'static>
Source§type Reborrowed<'b> = ApiPolicySpecView<'b>
type Reborrowed<'b> = ApiPolicySpecView<'b>
'b.Source§fn reborrow<'b>(this: &'b Self) -> &'b Self::Reborrowed<'b>
fn reborrow<'b>(this: &'b Self) -> &'b Self::Reborrowed<'b>
&'b Self (= &'b FooView<'static>) to
&'b Self::Reborrowed<'b> (= &'b FooView<'b>). The canonical body
is just this; the compiler accepts it via standard lifetime
variance for covariant view types. Read more