Struct GetCandlesRequest 

pub struct GetCandlesRequest {
    pub symbol_id: u32,
    pub timeframe: EnumValue<Timeframe>,
    pub limit: u32,
    pub start_time: MessageField<Timestamp>,
    pub end_time: MessageField<Timestamp>,
    pub include_incomplete: bool,
    pub include_reference: bool,
    pub page_token: String,
    /* private fields */
}

---

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: u32

Numeric spot market identifier.

Field 1: symbol_id

timeframe: EnumValue<Timeframe>

Candle bucket size. Required for ConnectRPC clients.

Field 2: timeframe

limit: u32

Maximum number of closed candles to return. Defaults to 500 when unset; max 10000.

Field 3: limit

start_time: MessageField<Timestamp>

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: MessageField<Timestamp>

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: 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

include_reference: 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

page_token: String

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

Implementations

impl GetCandlesRequest

pub const TYPE_URL: &'static str = "type.googleapis.com/marketdata.v1.GetCandlesRequest"

Protobuf type URL for this message, for use with Any::pack and Any::unpack_if.

Format: type.googleapis.com/<fully.qualified.TypeName>

Trait Implementations

impl Clone for GetCandlesRequest

fn clone(&self) -> GetCandlesRequest

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GetCandlesRequest

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for GetCandlesRequest

fn default() -> GetCandlesRequest

Returns the “default value” for a type.

impl DefaultInstance for GetCandlesRequest

fn default_instance() -> &'static Self

Return a reference to the single default instance of this type.

impl<'de> Deserialize<'de> for GetCandlesRequest

where GetCandlesRequest: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl ExtensionSet for GetCandlesRequest

const PROTO_FQN: &'static str = "marketdata.v1.GetCandlesRequest"

Fully-qualified proto type name of this message (no leading dot), e.g. "google.protobuf.FieldOptions".

fn unknown_fields(&self) -> &UnknownFields

Immutable access to the extendee’s unknown-field storage.

fn unknown_fields_mut(&mut self) -> &mut UnknownFields

Mutable access to the extendee’s unknown-field storage.

fn extension<C>(&self, ext: &Extension<C>) -> <C as ExtensionCodec>::Output

where C: ExtensionCodec,

Read an extension value.

fn set_extension<C>( &mut self, ext: &Extension<C>, value: <C as ExtensionCodec>::Value, )

where C: ExtensionCodec,

Write an extension value, replacing any prior occurrences.

fn has_extension<C>(&self, ext: &Extension<C>) -> bool

where C: ExtensionCodec,

Returns true if any record at the extension’s field number is present.

fn clear_extension<C>(&mut self, ext: &Extension<C>)

where C: ExtensionCodec,

Remove all records at the extension’s field number.

fn extension_or_default<C>( &self, ext: &Extension<C>, ) -> <C as ExtensionCodec>::Value

where C: ExtensionCodec<Output = Option<<C as ExtensionCodec>::Value>>, <C as ExtensionCodec>::Value: Default,

Read a singular extension value, returning the proto2 [default = ...] value if absent, or the type’s Default if no proto default was declared.

impl HasMessageView for GetCandlesRequest

type View<'a> = GetCandlesRequestView<'a>

The zero-copy view of Self, borrowing from a buffer with lifetime 'a.

type ViewHandle = GetCandlesRequestOwnedView

The generated 'static owned-view handle for Self (FooOwnedView).

fn decode_view(buf: &[u8]) -> Result<Self::View<'_>, DecodeError>

Decode a borrowed View from a byte slice.

fn decode_view_with_options<'a>( buf: &'a [u8], opts: &DecodeOptions, ) -> Result<Self::View<'a>, DecodeError>

Decode a borrowed View under custom DecodeOptions (recursion limit, max message size, unknown-field limit).

fn decode_view_handle(bytes: Bytes) -> Result<Self::ViewHandle, DecodeError>

Decode a ViewHandle from a Bytes buffer.

fn decode_view_handle_with_options( bytes: Bytes, opts: &DecodeOptions, ) -> Result<Self::ViewHandle, DecodeError>

Decode a ViewHandle with custom DecodeOptions (recursion limit, max message size).

impl Message for GetCandlesRequest

fn compute_size(&self, __cache: &mut SizeCache) -> u32

Returns the total encoded size in bytes.

The result is a u32; the protobuf specification requires all messages to fit within 2 GiB (2,147,483,647 bytes), so a compliant message will never overflow this type.

fn write_to(&self, __cache: &mut SizeCache, buf: &mut impl BufMut)

Write this message’s encoded bytes to a buffer, consuming nested-message sizes from cache (populated by a prior compute_size call on the same cache).

fn merge_field( &mut self, tag: Tag, buf: &mut impl Buf, ctx: DecodeContext<'_>, ) -> Result<(), DecodeError>

Processes a single already-decoded tag and its associated field data from buf.

fn clear(&mut self)

Clear all fields to their default values.

fn encode(&self, buf: &mut impl BufMut)

Compute size, then write. This is the primary encoding API.

fn encode_with_cache(&self, cache: &mut SizeCache, buf: &mut impl BufMut)

Encode using a caller-supplied SizeCache, for reuse across many encodes in a hot loop. Clears the cache first.

fn encoded_len(&self) -> u32

Compute the encoded byte size of this message.

fn encode_length_delimited(&self, buf: &mut impl BufMut)

Encode this message as a length-delimited byte sequence.

fn encode_to_vec(&self) -> Vec<u8>

Encode this message to a new Vec<u8>.

fn encode_to_bytes(&self) -> Bytes

Encode this message to a new bytes::Bytes.

fn decode(buf: &mut impl Buf) -> Result<Self, DecodeError>

where Self: Sized,

Decode a message from a buffer.

fn decode_from_slice(data: &[u8]) -> Result<Self, DecodeError>

where Self: Sized,

Decode a message from a byte slice.

fn decode_length_delimited(buf: &mut impl Buf) -> Result<Self, DecodeError>

where Self: Sized,

Decode a length-delimited message from a buffer.

fn merge_to_limit( &mut self, buf: &mut impl Buf, ctx: DecodeContext<'_>, limit: usize, ) -> Result<(), DecodeError>

Merge fields from a buffer until buf.remaining() reaches limit.

fn merge_group( &mut self, buf: &mut impl Buf, ctx: DecodeContext<'_>, field_number: u32, ) -> Result<(), DecodeError>

Merges a group-encoded message from buf, reading fields until an EndGroup tag with the given field_number is encountered.

fn merge( &mut self, buf: &mut impl Buf, ctx: DecodeContext<'_>, ) -> Result<(), DecodeError>

Merge fields from a buffer into this message.

fn merge_from_slice(&mut self, data: &[u8]) -> Result<(), DecodeError>

Merge fields from a byte slice into this message.

fn merge_length_delimited( &mut self, buf: &mut impl Buf, ctx: DecodeContext<'_>, ) -> Result<(), DecodeError>

Merge fields from a length-delimited sub-message payload into this message.

impl MessageName for GetCandlesRequest

const PACKAGE: &'static str = "marketdata.v1"

The protobuf package the message is declared in.

const NAME: &'static str = "GetCandlesRequest"

The unqualified message name, with . between nesting levels.

const FULL_NAME: &'static str = "marketdata.v1.GetCandlesRequest"

The fully-qualified protobuf type name with no leading dot.

const TYPE_URL: &'static str = "type.googleapis.com/marketdata.v1.GetCandlesRequest"

The google.protobuf.Any.type_url form for this message.

impl PartialEq for GetCandlesRequest

fn eq(&self, other: &GetCandlesRequest) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl ProtoElemJson for GetCandlesRequest

fn serialize_proto_json<S: Serializer>( v: &Self, s: S, ) -> Result<S::Ok, S::Error>

Serialize this value with proto3 JSON semantics.

fn deserialize_proto_json<'de, D: Deserializer<'de>>( d: D, ) -> Result<Self, D::Error>

Deserialize a value with proto3 JSON semantics.

impl Serialize for GetCandlesRequest

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for GetCandlesRequest