Struct BatchSearchChannelsRequest 

pub struct BatchSearchChannelsRequest { /* private fields */ }

Batched form of searchChannels. The map key of requests can be an arbitrary string identifier. It will be returned in the response as part of BatchedLocator.

Implementations

impl BatchSearchChannelsRequest

pub fn builder() -> Builder<QueryStage>

Returns a new builder.

impl BatchSearchChannelsRequest

pub fn new(query: ChannelSearchQuery, time_range: Range) -> Self

Constructs a new instance of the type.

pub fn requests(&self) -> &BTreeMap<String, BatchSearchChannelsEntry>

pub fn query(&self) -> &ChannelSearchQuery

pub fn time_range(&self) -> &Range

Time filter applied to the search. Only channels with data within this time range will be returned. A shorter time range will improve performance!

pub fn max_result_channels(&self) -> Option<i32>

Global cap on the merged channel result list. Defaults to 1000. Capped at 1000.

Trait Implementations

impl Clone for BatchSearchChannelsRequest

fn clone(&self) -> BatchSearchChannelsRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BatchSearchChannelsRequest

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for BatchSearchChannelsRequest

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<BatchSearchChannelsRequest> for Builder<Complete>

fn from(v: BatchSearchChannelsRequest) -> Self

Converts to this type from the input type.

impl Hash for BatchSearchChannelsRequest

fn hash<H: Hasher>(&self, hasher: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for BatchSearchChannelsRequest

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for BatchSearchChannelsRequest

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for BatchSearchChannelsRequest

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for BatchSearchChannelsRequest

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for BatchSearchChannelsRequest