Skip to main content

ChannelSearchService

Trait ChannelSearchService 

Source
pub trait ChannelSearchService<I: Iterator<Item = Result<Bytes, Error>>> {
    // Required methods
    fn get_locator_delimiters(
        &self,
        auth_: &BearerToken,
        request: &GetLocatorDelimitersRequest,
    ) -> Result<GetLocatorDelimitersResponse, Error>;
    fn list_channel_children(
        &self,
        auth_: &BearerToken,
        request: &ListChannelChildrenRequest,
    ) -> Result<ListChannelChildrenResponse, Error>;
    fn search_channels(
        &self,
        auth_: &BearerToken,
        request: &SearchChannelsRequest,
    ) -> Result<SearchChannelsResponse, Error>;
    fn batch_get_locator_delimiters(
        &self,
        auth_: &BearerToken,
        request: &BatchGetLocatorDelimitersRequest,
    ) -> Result<BatchGetLocatorDelimitersResponse, Error>;
    fn batch_search_channels(
        &self,
        auth_: &BearerToken,
        request: &BatchSearchChannelsRequest,
    ) -> Result<BatchSearchChannelsResponse, Error>;
    fn batch_list_channel_children(
        &self,
        auth_: &BearerToken,
        request: &BatchListChannelChildrenRequest,
    ) -> Result<BatchListChannelChildrenResponse, Error>;
}
Expand description

Channel search over a DataFrame, which can expand to multiple locators.

Required Methods§

Source

fn get_locator_delimiters( &self, auth_: &BearerToken, request: &GetLocatorDelimitersRequest, ) -> Result<GetLocatorDelimitersResponse, Error>

Returns the expanded locator topology for a frame plus per-locator delimiter info.

Source

fn list_channel_children( &self, auth_: &BearerToken, request: &ListChannelChildrenRequest, ) -> Result<ListChannelChildrenResponse, Error>

Lazy one-level hierarchical expansion under parent. Returns a mix of leaf channels and prefix nodes, each labelled with the set of locators where they exist.

Source

fn search_channels( &self, auth_: &BearerToken, request: &SearchChannelsRequest, ) -> Result<SearchChannelsResponse, Error>

Flat text search across the frame. Returns matching channels, each labelled with the set of locators in which they exist.

Source

fn batch_get_locator_delimiters( &self, auth_: &BearerToken, request: &BatchGetLocatorDelimitersRequest, ) -> Result<BatchGetLocatorDelimitersResponse, Error>

Batched form of getLocatorDelimiters.

Source

fn batch_search_channels( &self, auth_: &BearerToken, request: &BatchSearchChannelsRequest, ) -> Result<BatchSearchChannelsResponse, Error>

Batched form of searchChannels. The channel search is performed across the union of all entry scopes and so is the limit and top-n selection by relevance.

Source

fn batch_list_channel_children( &self, auth_: &BearerToken, request: &BatchListChannelChildrenRequest, ) -> Result<BatchListChannelChildrenResponse, Error>

Batched form of listChannelChildren. The hierarchical expansion is performed across the union of all entry scopes for the shared parent path.

Implementors§

Source§

impl<I: Iterator<Item = Result<Bytes, Error>>, __C> ChannelSearchService<I> for ChannelSearchServiceClient<__C>
where __C: Client<ResponseBody = I>,