pub struct GetCandlesRequestOwnedView(/* private fields */);Expand description
Self-contained, 'static owned view of a GetCandlesRequest message.
Wraps ::buffa::OwnedView<GetCandlesRequestView<'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 GetCandlesRequestView when you need struct patterns, iteration helpers, or to pass the view to lifetime-parameterised code.
Implementations§
Source§impl GetCandlesRequestOwnedView
impl GetCandlesRequestOwnedView
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: &GetCandlesRequest) -> Result<Self, DecodeError>
pub fn from_owned(msg: &GetCandlesRequest) -> 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) -> &GetCandlesRequestView<'_>
pub fn view(&self) -> &GetCandlesRequestView<'_>
Borrow the full GetCandlesRequestView with its lifetime tied to &self.
Sourcepub fn to_owned_message(&self) -> Result<GetCandlesRequest, DecodeError>
pub fn to_owned_message(&self) -> Result<GetCandlesRequest, 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 timeframe(&self) -> EnumValue<Timeframe>
pub fn timeframe(&self) -> EnumValue<Timeframe>
Candle bucket size. Required for ConnectRPC clients.
Field 2: timeframe
Sourcepub fn limit(&self) -> u32
pub fn limit(&self) -> u32
Maximum number of closed candles to return. Defaults to 500 when unset; max 10000.
Field 3: limit
Sourcepub fn start_time(&self) -> &MessageFieldView<TimestampView<'_>>
pub fn start_time(&self) -> &MessageFieldView<TimestampView<'_>>
Inclusive lower bound for candle bucket start time, as a UTC timestamp. Must not be more than 5 minutes in the future.
Field 4: start_time
Sourcepub fn end_time(&self) -> &MessageFieldView<TimestampView<'_>>
pub fn end_time(&self) -> &MessageFieldView<TimestampView<'_>>
Inclusive upper bound for candle bucket start time, as a UTC timestamp. Must be greater than or equal to start_time when both are set, and must not be more than 5 minutes in the future.
Field 5: end_time
Sourcepub fn include_incomplete(&self) -> bool
pub fn include_incomplete(&self) -> bool
Include the current open candle when it is available and inside the requested range. The open candle is prepended to the newest-first candle list and does not count toward the closed-candle limit.
Field 6: include_incomplete
Sourcepub fn include_reference(&self) -> bool
pub fn include_reference(&self) -> bool
Include the composite reference market candle series for the same market, timeframe, and time range. The reference series can be empty when no reference series is available for the requested timeframe.
Field 7: include_reference
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, timeframe, time bounds, and newest-first candle ordering. Inclusion flags affect response enrichment and may change between pages.
Field 8: page_token
Trait Implementations§
Source§impl AsRef<OwnedView<GetCandlesRequestView<'static>>> for GetCandlesRequestOwnedView
impl AsRef<OwnedView<GetCandlesRequestView<'static>>> for GetCandlesRequestOwnedView
Source§fn as_ref(&self) -> &OwnedView<GetCandlesRequestView<'static>>
fn as_ref(&self) -> &OwnedView<GetCandlesRequestView<'static>>
Source§impl Clone for GetCandlesRequestOwnedView
impl Clone for GetCandlesRequestOwnedView
Source§fn clone(&self) -> GetCandlesRequestOwnedView
fn clone(&self) -> GetCandlesRequestOwnedView
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read more