pub struct GetOrderbookHeatmapRequestOwnedView(/* private fields */);Expand description
Self-contained, 'static owned view of a GetOrderbookHeatmapRequest message.
Wraps ::buffa::OwnedView<GetOrderbookHeatmapRequestView<'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 GetOrderbookHeatmapRequestView when you need struct patterns, iteration helpers, or to pass the view to lifetime-parameterised code.
Implementations§
Source§impl GetOrderbookHeatmapRequestOwnedView
impl GetOrderbookHeatmapRequestOwnedView
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: &GetOrderbookHeatmapRequest) -> Result<Self, DecodeError>
pub fn from_owned(msg: &GetOrderbookHeatmapRequest) -> 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) -> &GetOrderbookHeatmapRequestView<'_>
pub fn view(&self) -> &GetOrderbookHeatmapRequestView<'_>
Borrow the full GetOrderbookHeatmapRequestView with its lifetime tied to &self.
Sourcepub fn to_owned_message(
&self,
) -> Result<GetOrderbookHeatmapRequest, DecodeError>
pub fn to_owned_message( &self, ) -> Result<GetOrderbookHeatmapRequest, 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 interval(&self) -> EnumValue<HeatmapInterval>
pub fn interval(&self) -> EnumValue<HeatmapInterval>
Heatmap bucket interval.
Field 2: interval
Sourcepub fn depth(&self) -> EnumValue<HeatmapDepth>
pub fn depth(&self) -> EnumValue<HeatmapDepth>
Top-N levels per side included in each bucket.
Field 3: depth
Sourcepub fn time_range(&self) -> &MessageFieldView<HeatmapTimeRangeView<'_>>
pub fn time_range(&self) -> &MessageFieldView<HeatmapTimeRangeView<'_>>
Absolute time range for the first page. Reuse the same request filters and pass page_token from the prior response to continue older buckets.
Field 4: time_range
Sourcepub fn page_token(&self) -> &str
pub fn page_token(&self) -> &str
Opaque keyset cursor from a previous response. The cursor is exclusive and bound to symbol, interval, depth, quantity mode, and the original time range.
Field 5: page_token
Sourcepub fn limit(&self) -> u32
pub fn limit(&self) -> u32
Maximum number of delta buckets returned (min 1, max 20000).
This limit counts only chain.deltas; chain.base_keyframe is not counted.
Field 6: limit
Sourcepub fn quantity_mode(&self) -> EnumValue<HeatmapQuantityMode>
pub fn quantity_mode(&self) -> EnumValue<HeatmapQuantityMode>
Quantity mode used for qty_scaled in snapshot/delta levels:
- CLOSE: end-of-bucket quantity
- PEAK: intra-bucket peak quantity
Field 7: quantity_mode
Trait Implementations§
Source§impl AsRef<OwnedView<GetOrderbookHeatmapRequestView<'static>>> for GetOrderbookHeatmapRequestOwnedView
impl AsRef<OwnedView<GetOrderbookHeatmapRequestView<'static>>> for GetOrderbookHeatmapRequestOwnedView
Source§fn as_ref(&self) -> &OwnedView<GetOrderbookHeatmapRequestView<'static>>
fn as_ref(&self) -> &OwnedView<GetOrderbookHeatmapRequestView<'static>>
Source§impl Clone for GetOrderbookHeatmapRequestOwnedView
impl Clone for GetOrderbookHeatmapRequestOwnedView
Source§fn clone(&self) -> GetOrderbookHeatmapRequestOwnedView
fn clone(&self) -> GetOrderbookHeatmapRequestOwnedView
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read more