pub struct GetCandlesRequestView<'a> {
pub symbol_id: u32,
pub timeframe: EnumValue<Timeframe>,
pub limit: u32,
pub start_time: MessageFieldView<TimestampView<'a>>,
pub end_time: MessageFieldView<TimestampView<'a>>,
pub include_incomplete: bool,
pub include_reference: bool,
pub page_token: &'a str,
pub __buffa_unknown_fields: UnknownFieldsView<'a>,
}Expand description
§GetCandles: Binary (protobuf) request/response with scaled integers. REST responses expose decimal strings.
GetCandlesRequest selects a spot market candle series.
The response is ordered newest-first by candle bucket start time. When both start_time and end_time are set, both bounds are inclusive.
Fields§
§symbol_id: u32Numeric spot market identifier.
Field 1: symbol_id
timeframe: EnumValue<Timeframe>Candle bucket size. Required for ConnectRPC clients.
Field 2: timeframe
limit: u32Maximum number of closed candles to return. Defaults to 500 when unset; max 10000.
Field 3: limit
start_time: MessageFieldView<TimestampView<'a>>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
end_time: MessageFieldView<TimestampView<'a>>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
include_incomplete: boolInclude 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
include_reference: boolInclude 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
page_token: &'a strOpaque 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
__buffa_unknown_fields: UnknownFieldsView<'a>Trait Implementations§
Source§impl<'a> Clone for GetCandlesRequestView<'a>
impl<'a> Clone for GetCandlesRequestView<'a>
Source§fn clone(&self) -> GetCandlesRequestView<'a>
fn clone(&self) -> GetCandlesRequestView<'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 GetCandlesRequestView<'a>
impl<'a> Debug for GetCandlesRequestView<'a>
Source§impl<'a> Default for GetCandlesRequestView<'a>
impl<'a> Default for GetCandlesRequestView<'a>
Source§fn default() -> GetCandlesRequestView<'a>
fn default() -> GetCandlesRequestView<'a>
Source§impl<'v> DefaultViewInstance for GetCandlesRequestView<'v>
impl<'v> DefaultViewInstance for GetCandlesRequestView<'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 GetCandlesRequestView<'a>
impl<'a> MessageName for GetCandlesRequestView<'a>
Source§const PACKAGE: &'static str = "marketdata.v1"
const PACKAGE: &'static str = "marketdata.v1"
Source§const NAME: &'static str = "GetCandlesRequest"
const NAME: &'static str = "GetCandlesRequest"
. between nesting levels. Read moreSource§impl<'a> MessageView<'a> for GetCandlesRequestView<'a>
impl<'a> MessageView<'a> for GetCandlesRequestView<'a>
Source§type Owned = GetCandlesRequest
type Owned = GetCandlesRequest
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<GetCandlesRequest, DecodeError>
fn to_owned_message(&self) -> Result<GetCandlesRequest, DecodeError>
Source§fn to_owned_from_source(
&self,
__buffa_src: Option<&Bytes>,
) -> Result<GetCandlesRequest, DecodeError>
fn to_owned_from_source( &self, __buffa_src: Option<&Bytes>, ) -> Result<GetCandlesRequest, 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 GetCandlesRequestView<'__a>
Serializes this view as protobuf JSON.
impl<'__a> Serialize for GetCandlesRequestView<'__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 GetCandlesRequestView<'a>
impl<'a> ViewEncode<'a> for GetCandlesRequestView<'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 GetCandlesRequestView<'static>
impl ViewReborrow for GetCandlesRequestView<'static>
Source§type Reborrowed<'b> = GetCandlesRequestView<'b>
type Reborrowed<'b> = GetCandlesRequestView<'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